Skip to content

Commit 94c74cd

Browse files
Update README.md
1 parent 7ba5a3e commit 94c74cd

1 file changed

Lines changed: 33 additions & 57 deletions

File tree

README.md

Lines changed: 33 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -18,77 +18,53 @@
1818

1919
</div>
2020

21-
## Modules
21+
## FancyPlugins
2222

23-
> [!TIP]
24-
> Read the [monorepo.md](docs/src/development-guidelines/monorepo.md) for more information about the monorepo.
25-
> Here is a blog article about why we use a monorepo: [why-monorepo.md](docs/src/blog/why-monorepo.md).
23+
This is a [monorepo](docs/src/development-guidelines/monorepo.md) for all plugins, libraries, and tools of FancyInnovations.
2624

2725
**Plugins:**
28-
- FancyNpcs: create and manage fancy looking npcs ([old repository](https://github.com/FancyMcPlugins/FancyNpcs))
29-
- FancyHolograms (v2): create fancy looking holograms ([old repository](https://github.com/FancyMcPlugins/FancyHolograms))
30-
- FancyHolograms (v3): create fancy looking holograms (work in progress)
26+
- FancyNpcs: create and manage fancy looking npcs
27+
- FancyHolograms: create fancy looking holograms
3128
- FancyDialogs: create and manage fancy looking dialogs which were added in 1.21.6 (work in progress)
3229
- FancyVisuals: plugin to customize all visual components of the game (work in progress)
3330

3431
**Libraries:**
35-
- Common: common classes and utilities (FancyLib previously)
36-
- JDB: json database library (included in FancyLib previously)
37-
- Plugin Tests: testing library for plugins (included in FancyLib previously)
38-
- Packets: packet handling library (FancySitula previously)
32+
- Common: common classes and utilities
33+
- JDB: json database library
34+
- Plugin Tests: testing library for plugins
35+
- Packets: packet handling library (also called FancySitula)
3936

4037
**Tools:**
4138
- Deployment: deploy plugins to platforms like modrinth
4239
- Quick E2E: generate a quick end-to-end environment for testing
4340

44-
Future packages that are planned to be added to the monorepo:
45-
- fancywebsite: https://github.com/FancyInnovations/FancyWebsite
46-
- (fancymorphs: https://github.com/FancyInnovations/FancyMorphs)
47-
- minecraft-client: a lightweight Minecraft client for testing
48-
4941
## Usage
5042

51-
The monorepo uses Gradle as build system. See [monorepo.md](docs/src/development-guidelines/monorepo.md) for more information.
43+
The monorepo uses Gradle as a build system. See [monorepo.md](docs/src/development-guidelines/monorepo.md) for more information.
5244

5345
To see specific usage for each package, see the README.md in the respective package directory.
5446

55-
## Contributors
56-
57-
Since this is a new repository, the list of contributors didn't get migrated from the previous repositories.
58-
Here is a list of contributors to the previous repositories:
59-
60-
- [Grabsky](https://github.com/Grabsky)
61-
- [OakLoaf](https://github.com/OakLoaf)
62-
- [Matt-MX](https://github.com/MattMX)
63-
- [Sxtanna](https://github.com/Sxtanna)
64-
- [airoons](https://github.com/airoons)
65-
- [BitByLogics](https://github.com/BitByLogics)
66-
- [devpeaqe](https://github.com/devpeaqe)
67-
- [NonSwag](https://github.com/NonSwag)
68-
- [FrezzyDev](https://github.com/FrezzyDev)
69-
- [perkojack](https://github.com/perkojack)
70-
- [BigTows](https://github.com/BigTows)
71-
- [kforbro](https://github.com/kforbro)
72-
- [Kamillaova](https://github.com/Kamillaova)
73-
- [Emibergo02](https://github.com/Emibergo02)
74-
- [bridgelol](https://github.com/bridgelol)
75-
- [Seshpenguin](https://github.com/Seshpenguin)
76-
- [UltraFaceguy](https://github.com/UltraFaceguy)
77-
- [4drian3d](https://github.com/4drian3d)
78-
- [Zemux1613](https://github.com/Zemux1613)
79-
- [Yive](https://github.com/Yive)
80-
- [UsainSrht](https://github.com/UsainSrht)
81-
- [killerprojecte](https://github.com/killerprojecte)
82-
- [SirSalad](https://github.com/SirSalad)
83-
- [yukisnowflake](https://github.com/yukisnowflake)
84-
- [BiFTHg](https://github.com/BiFTHg)
85-
- [alexcastro1919](https://github.com/alexcastro1919)
86-
- [FrinshHD](https://github.com/FrinshHD)
87-
- [xii69](https://github.com/xii69)
88-
- [ruViolence](https://github.com/ruViolence)
89-
- [JonasDevDE](https://github.com/JonasDevDE)
90-
- [CloveTwilight3](https://github.com/CloveTwilight3)
91-
92-
*(Taken from https://github.com/FancyMcPlugins/FancyNpcs/graphs/contributors and https://github.com/FancyMcPlugins/FancyHolograms/graphs/contributors)*
93-
94-
If you contributed to the previous repositories and want to be listed here, please open an issue or a pull request.
47+
## Contributing
48+
49+
You can contribute to this repository by reporting bugs, suggesting features, or contributing code.
50+
Please read the [contributing guidelines](docs/src/development-guidelines/contributing.md) for more information.
51+
52+
---
53+
54+
[All contributors of this repository:](https://github.com/FancyInnovations/FancyPlugins/graphs/contributors)
55+
56+
<a href = "https://github.com/FancyInnovations/FancyPlugins/graphs/contributors">
57+
<img src = "https://contrib.rocks/image?repo=FancyInnovations/FancyPlugins" alt="All contributors of this repository"/>
58+
</a>
59+
60+
**[All contributors of the old FancyNpcs repository:](https://github.com/FancyMcPlugins/FancyNpcs/graphs/contributors)**
61+
62+
<a href = "https://github.com/FancyMcPlugins/FancyNpcs/graphs/contributors">
63+
<img src = "https://contrib.rocks/image?repo=FancyMcPlugins/FancyNpcs" alt="All contributors of the old FancyNpcs repository"/>
64+
</a>
65+
66+
**[All contributors of the old FancyHolograms repository:](https://github.com/FancyMcPlugins/FancyHolograms/graphs/contributors)**
67+
68+
<a href = "https://github.com/FancyMcPlugins/FancyHolograms/graphs/contributors">
69+
<img src = "https://contrib.rocks/image?repo=FancyMcPlugins/FancyHolograms" alt="All contributors of the old FancyHolograms repository"/>
70+
</a>

0 commit comments

Comments
 (0)