Skip to content

Commit c082935

Browse files
committed
update index
1 parent 585f043 commit c082935

1 file changed

Lines changed: 95 additions & 34 deletions

File tree

docs/en/index.md

Lines changed: 95 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,33 @@
1-
Pylon is an **upcoming** Minecraft Java plugin that will hugely expand vanilla gameplay with new content, including electric machines, huge multiblocks, a fully-fledged fluid system, a complex smelting system, extensive automation options and much, a research system, and much more. It is intended to supersede Slimefun.
1+
Pylon is an upcoming Minecraft Java technology plugin that will hugely expand vanilla gameplay with new content: electricity, diesel machines, new fluids and fluid pipes, logistics, and much, much more!
2+
3+
## :wrench: Features
4+
5+
- :white_check_mark: Manual machines (mixing pot, grindstone, magic altar, hammer, and much more!)
6+
- :white_check_mark: Hydraulic machines (early-game automation)
7+
- :white_check_mark: Fluid pipes & new fluids
8+
- :white_check_mark: Smelting & alloying system
9+
- :white_check_mark: Multiblocks
10+
- :white_check_mark: Research system (unlock new items with research points)
11+
- :white_check_mark: Per-player language support
12+
- :white_check_mark: Comprehensive and user-friendly in-game guide
13+
- :white_check_mark: Extensive server customisation options (including per-machine settings and customisable recipes)
14+
- :white_check_mark: First-class addon support (even all of Pylon's base content is added using an addon!)
15+
- :construction: Performance tuning options (limit the number of blocks per chunk/player, configure tick rates, etc)
16+
- :construction: First-class texture pack support + 'official' texture pack (including blocks)
17+
- :construction: Diesel machines (mid-game automation)
18+
- :construction: Cargo system (automatically move items from A to B)
19+
- :o: Electric machines (end-game automation)
20+
- :o: AE2-style endgame logistics system
21+
- :o: Builtin profiler for determining what's causing the most lag
22+
- :o: Bedrock support (via Geyser)
223

3-
Pylon uses an addon system, meaning anyone can add content to Pylon by writing an addon for it! It also comes with a number of really useful features, such as:
24+
## :calendar: Provisional timeline
425

5-
- First-class translation support, meaning each player can select their own language.
6-
- Extensive configuration options, including per-machine configuration.
7-
- An intuitive and user-friendly guide to help players figure out the plugin.
26+
- **December 2025** - Most/all diesel machines fully implemented
27+
- **January 2025** - Cargo system fully implemented
28+
- **February 2025** - Open alpha testing (likely hosted on MetaMechanists - my own server) begins. We will most likely run several seasons of Pylon that each last a few weeks, to iron out bugs, test performance, improve stability and UX, and make sure the plugin is ready to be released.
29+
- **April 2025** - Electricity fully implemented
30+
- **Mid 2026** - Pylon officially released
831

932
## :frame_photo: Pylon in pictures (so far)
1033

@@ -21,59 +44,97 @@ Pylon uses an addon system, meaning anyone can add content to Pylon by writing a
2144
![Using the magic altar](img/using-magic-altar.png)
2245
![Using the smeltery](img/using-smeltery.png)
2346

24-
## :stopwatch: Performance & stability
47+
## :link: Links
2548

26-
We have built Pylon with performance and stability in mind from day 1:
49+
- Discord invite: [https://discord.gg/4tMAnBAacW](https://discord.gg/4tMAnBAacW)
50+
- Github: [https://github.com/pylonmc](https://github.com/pylonmc)
2751

28-
- Pylon makes **extensive** use of caching and will run most performance-intensive systems asynchronously, as well as makeing use of modern concurrency/performance features such as coroutines.
29-
- In addition, the plugin will have a broad range of config options to help performance - including per-machine tick rates, the ability to limit the number of machines placed by player/chunk/etc, the tick rate of fluid/energy/etc, and more.
30-
- The way Pylon is designed minimises the chance of data corruption and has a range of error-handling mechanisms if something does go wrong.
31-
Note: Pylon will likely not be fully compatible with bedrock.
52+
## :tools: For server admins
3253

33-
## :calendar: Provisional timeline
54+
### Performance
55+
56+
- :gear: Even huge multiblocks will have **almost zero** performance impact compared to a normal Pylon block
57+
- :gear: Most of Pylon will eventually run asynchronously
58+
- :gear: Performance is literally built into Pylon's design - systems like fluid pipes and cargo were designed from the ground up in the most performant way possible
59+
- :gear: You will be able to limit the number of each type of block per player or per chunk
60+
- :gear: Pylon will have many more performance options, such as making fluid pipes tick less often, or reducing tick rates of individual types of machines
61+
- :gear: We plan to add a purpose-built profiler so you can see exactly what blocks & items are using the most CPU or memory
3462

35-
**September/October 2025** - Invite-only alpha testing begins.
63+
### Stability
3664

37-
**Novemeber/December 2025** - Open alpha testing (likely hosted on MetaMechanists - my own server) begins. We will most likely run several seasons of Pylon that each last a few weeks, to iron out bugs, test performance, improve stability and UX, and make sure the plugin is ready to be released.
65+
- :gear: Easily disable any problematic blocks or items
66+
- :gear: Pylon will refuse to start if it detects any configuration issues
67+
- :gear: Blocks that throw errors will be safely unloaded
68+
- :gear: Removing addons is safe, with all the data kept intact and restored if the addon is re-added
69+
- :gear: Pylon data is stored **in the world data itself** - no need to keep extra backups
3870

39-
**Early/mid 2026** - Pylon is officially released
71+
### Customisation
4072

41-
## :keyboard: Developing Pylon addons
73+
- :gear: The unlocks and costs of each research are configurable
74+
- :gear: All recipes are configurable
75+
- :gear: Most blocks and items have settings determining their tick rate, speed, diesel usage, etc
4276

43-
We've gone to great lengths to make Pylon easy, intuitive, flexible, and most importantly, fun to develop addons for. A lot of painful lessons learnt from hundreds of hours of Slimefun addon development have guided Pylon's API, and the result is something that's intuitive and easy to work with, while being very flexible. Pylon also fully supports addons written in Kotlin, which is much nicer to write than Java.
77+
## :keyboard: For developers
4478

45-
Currently, addon development is not supported due to how rapidly Pylon is still changing, and the lack of high-level documentation on how to do it. We plan to soon have a detailed guide on how to create an addon and how to take advantages of all the systems Pylon has to offer, so watch this space!
79+
### Addon development
4680

47-
## :link: Clicky things
81+
- :gear: Pylon has first-class addon support; all the base content is added using an addon!
82+
- :gear: Pylon supports addons written in Kotlin
83+
- :gear: Blocks, items, recipes, guide pages, fluids, and entities are all easy and intuitive to add
84+
- :gear: Pylon will have extensive high-level documentation on all the features it has to offer
4885

49-
Discord invite: [https://discord.gg/4tMAnBAacW](https://discord.gg/4tMAnBAacW)
86+
:warning: Currently, addon development is not supported due to how rapidly Pylon is still changing.
5087

51-
Github: [https://github.com/pylonmc](https://github.com/pylonmc)
88+
### Examples
89+
90+
See the following code to get a feel for how Pylon works:
91+
92+
- :link: Portable dustbin: [https://github.com/pylonmc/pylon-base/blob/master/src/main/java/io/github/pylonmc/pylon/base/content/tools/PortableDustbin.java](https://github.com/pylonmc/pylon-base/blob/master/src/main/java/io/github/pylonmc/pylon/base/content/tools/PortableDustbin.java)
93+
- :link: Fireproof rune: [https://github.com/pylonmc/pylon-base/blob/master/src/main/java/io/github/pylonmc/pylon/base/content/tools/FireproofRune.java](https://github.com/pylonmc/pylon-base/blob/master/src/main/java/io/github/pylonmc/pylon/base/content/tools/FireproofRune.java)
94+
- :link: Hammer recipe type: [https://github.com/pylonmc/pylon-base/blob/master/src/main/java/io/github/pylonmc/pylon/base/recipes/HammerRecipe.java](https://github.com/pylonmc/pylon-base/blob/master/src/main/java/io/github/pylonmc/pylon/base/recipes/HammerRecipe.java)
95+
- :link: Hammer recipe files: [https://github.com/pylonmc/pylon-base/blob/master/src/main/resources/recipes/pylonbase/hammer.yml](https://github.com/pylonmc/pylon-base/blob/master/src/main/resources/recipes/pylonbase/hammer.yml)
96+
- :link: Base English language file: [https://github.com/pylonmc/pylon-base/blob/master/src/main/resources/lang/en.yml](https://github.com/pylonmc/pylon-base/blob/master/src/main/resources/lang/en.yml)
97+
- :link: Press block: [https://github.com/pylonmc/pylon-base/blob/master/src/main/java/io/github/pylonmc/pylon/base/content/machines/simple/Press.java](https://github.com/pylonmc/pylon-base/blob/master/src/main/java/io/github/pylonmc/pylon/base/content/machines/simple/Press.java)
98+
- :link: Hydraulic excavator settings: [https://github.com/pylonmc/pylon-base/blob/master/src/main/resources/settings/hydraulic_excavator.yml](https://github.com/pylonmc/pylon-base/blob/master/src/main/resources/settings/hydraulic_excavator.yml)
5299

53-
Documentation **(heavy work in progress):** [https://pylonmc.github.io/](https://pylonmc.github.io/)
54100

55101
## :detective: The team
56102

57-
Currently, the core team developing Pylon is:
103+
### Lead developers
104+
105+
@seggan :flag_us: - a veteran Slimefun addon developer (SlimefunWarfare, SFCalc, Galactifun), with a impressive contribution record for SF addons, Paper, and Slimefun. Seggan is responsible for many core Pylon systems, including translation, WAILA, researches, the smeltery, the recipe system, and more.
106+
@ohmvir :flag_ca: - new to plugin development, but has done a fantastic job getting up to speed and adding lots of base content, like talismans and the beheading sword, as well as a *lot* of various smaller technical changes & bug fixes.
107+
@overlordidra (me!) :flag_gb: - owner of a Slimefun server for 5 years & Quaptics developer. I have developed many of the core systems including the Pylon guide, fluid system, hydraulics, cargo, diesel, automated tests, block storage, and more.
58108

59-
@ohmvir :flag_ca: - a relatively fresh but enthusiastic face from MetaMechanists who's new to plugin development, but has done a fantastic job getting up to speed and adding lots of base content, like the health talismans and beheading sword, as well as tackling various tasks that need doing here and there.
109+
### Artists
110+
@pandicka :flag_cz: - a talented texture pack artist who worked on Slimefun texture packs, and has created the majority of the Pylon resource pack.
60111

61-
@overlordidra :flag_gb: - owner of MetaMechanists (a popular Slimefun server) for over 4 years and the developer behind Quaptics. Many of the core systems - most notably the Pylon guide, the fluid system, hydraulics, the automated test code, and the core systems that keep track of custom blocks/entities/items, are his doing.
112+
### Developers
113+
@vaan1310 :flag_it: - previously headed a geopolitics server and has been doing a lot of valuable work on the 'smaller stuff' - resolving issues, fixing bugs, adding polishing, making technical changes, and lots more.
114+
@justahuman_xd :flag_us: - head developer on my server for 3 years and works professionally in the Minecraft space. He has done the majority of the texture pack support side of Pylon, and other various smaller refinements.
115+
@tinalness :flag_cn: - former Slimefun addon developer (JustEnoughGuide, SlimefunTimeIt, MSUA, AdvancedBan, and more) who has contributed to Pylon (primarily the recipe ingredient calculation system) and also has already written two addons.
116+
@ihateblueb :flag_us: - has run a Slimefun server (Orchid) for several years and has added some neat content like the elevator.
62117

63-
@seggan :flag_us: - a veteran Slimefun addon developer behind SlimefunWarfare, SFCalc, and the very successful Galactifun addon, with a very impressive contribution record for other addons, the Paper server software, and Slimefun itself. Seggan is responsible for many of the core Pylon systems, including most notably the entire translation system, WAILA, the research system, the internal registry system, and the recipe system (and has done lots more smaller features!).
118+
**Interested in helping out? Ask us on [Discord](https://discord.gg/4tMAnBAacW) and we can find you some issues to get started.**
64119

65-
We also have help from:
120+
## :question: Q&A
66121

67-
@ihateblueb who has run a Slimefun server (Orchid) and is helping us add more content (the elevator is her doing!).
122+
Q: **How do I install Pylon?**
123+
Read the installation guide at [https://pylonmc.github.io/installation/installing-pylon/](https://pylonmc.github.io/installation/installing-pylon/). Beware that **Pylon is still experimental and you should not run it outside of an expendable test server.**
68124

69-
@justahuman_xd who is responsible for many of the more hacky things we do, namely the block and armor texture systems. He also has a *lot* of Slimefun development experience under his belt and has given a lot of useful input and guidance on the project.
125+
Q: **Will Pylon support Slimefun addons?**
126+
No. Migrating from Slimefun to Pylon is non-trivial, and we advise addon developers to rewrite their addons entirely to better suit Pylon's progression and style rather than attempting to migrate them 1-to-1.
70127

71-
@.ph.enix who used to manage all our CI - he set up automatic testing on our pull requests, and set up the system to publish new versions of Pylon. Unfortunately, he has left the project, but we are very grateful for all his help!
128+
Q: **What versions will Pylon support?**
129+
We plan to keep each Pylon version compatible with the latest version of Minecraft at the time. To make it easier and faster for us to update, **each version of Pylon will only support one version of Minecraft.** This means you will need to use older versions of Pylon for older versions of Minecraft. Critical fixes will be backported.
72130

73-
@vaan1310 who has implemented quite a few bits here and there, such as bug fixes and data-driven researches, as well as helping out with pull request reviews.
131+
Q: **What server software can Pylon run on?**
132+
Paper or paper forks only. Folia support may come later down the line.
74133

75-
If you're interested in helping out, drop us a message on our Discord server! You don't have to be an expert to help, a little plugin development experience is enough - there are plenty of tasks to do, ranging from trivial to exceptionally complex, so just let us know if you're interested and we can find something for you to do.
134+
Q: **Will Pylon support bedrock (via Geyser)?**
135+
Eventually, yes, but it is not a high priority and will be one of the last things added. Geyser is very hard for a project like this to support and there will be some jank.
76136

77-
## :question: Got questions?
137+
Q: **When will Pylon be ready?**
138+
See the 'Provisional Timeline' section above
78139

79-
Drop a message on our Discord server and we'll be happy to answer.
140+
**If you have a different question, drop a message on [Discord](https://discord.gg/4tMAnBAacW) and we'll be happy to answer.**

0 commit comments

Comments
 (0)