You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/index.md
+31-30Lines changed: 31 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
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
2
3
+
Pylon is built using Rebar, the engine that powers Pylon. Rebar is a framework built from the ground up to allow us to add custom blocks, items, researches, etc. Rebar also implements complex systems such as fluid handling logic and cargo routing. **Pylon is actually a Rebar addon**.
4
+
3
5
[:simple-discord: Join us on Discord :material-arrow-right:](https://discord.gg/4tMAnBAacW){ .md-button } [:simple-github: Find us on GitHub :material-arrow-right:](https://github.com/pylonmc){ .md-button } [:material-server: Install Pylon :material-arrow-right:](home/installing-pylon.md){ .md-button }
| :white_check_mark: | Cargo system (automatically move items from A to B)
36
37
| :o: | Electric machines (end-game automation)
37
38
| :o: | AE2-style endgame logistics system
38
39
| :o: | Builtin profiler for determining what's causing the most lag
@@ -53,36 +54,36 @@ Keep reading to find out more.
53
54
54
55
| Role | Member | Bio |
55
56
| ---- | ------ | --- |
56
-
| <spanstyle="color: #ff0000;">Lead Developer</span> | :flag_us: Seggan | 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. |
57
+
| <spanstyle="color: #ff0000;">Lead Developer</span> | :flag_us: Seggan | 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 Rebar and Pylon systems, including translation, WAILA, researches, the smeltery, the recipe system, and more. |
57
58
| <spanstyle="color: #ff0000;">Lead Developer</span> | :flag_ca: Ohm | 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. |
58
59
| <spanstyle="color: #ff0000;">Lead Developer</span> | :flag_gb: Idra | 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|
59
60
| <spanstyle="color: #e67e22;">Developer</span> | :flag_it: Vaan | 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. |
60
61
| <spanstyle="color: #e67e22;">Developer</span> | :flag_us: Justin | 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.
61
62
| <spanstyle="color: #f8ac2e;">Artist</span> | :flag_cz: Pandicka | A talented texture pack artist who worked on Slimefun texture packs, and has created the majority of the Pylon resource pack. |
62
-
| <spanstyle="color: #bc915c;">Contributor</span> | :flag_cn: Balugaq | 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. |
63
+
| <spanstyle="color: #bc915c;">Contributor</span> | :flag_cn: Balugaq | Former Slimefun addon developer (JustEnoughGuide, SlimefunTimeIt, MSUA, AdvancedBan, and more) who has contributed to Pylon/Rebar (primarily the recipe ingredient calculation system) and also has already written two addons. |
63
64
| <spanstyle="color: #bc915c;">Contributor</span> | :flag_us: Blueb | Has run a Slimefun server (Orchid) for several years and has added some neat content like the elevator. |
64
-
| <spanstyle="color: #bc915c;">Contributor</span> | :flag_cn: Ybw0014 | Former Slimefun addon developer who ran the Slimefun community. Helped with some of the Pylon docs. |
65
+
| <spanstyle="color: #bc915c;">Contributor</span> | :flag_cn: Ybw0014 | Former Slimefun addon developer who ran the Slimefun community. Helped with some of the Pylon/Rebar docs. |
65
66
66
67
---
67
68
68
69
## :tools: For server admins
69
70
70
71
### Performance
71
72
72
-
-:gear: Even huge multiblocks will have **almost zero** performance impact compared to a normal Pylon block
73
-
-:gear: Most of Pylon will eventually run asynchronously
74
-
-: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
73
+
-:gear: Even huge multiblocks will have **almost zero** performance impact compared to a normal Rebar block
74
+
-:gear: Most of Rebar/Pylon will eventually run asynchronously
75
+
-:gear: Performance is literally built into Rebar/Pylon's design - systems like fluid pipes and cargo were designed from the ground up in the most performant way possible
75
76
-:gear: You will be able to limit the number of each type of block per player or per chunk
76
-
-: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
77
+
-:gear: Pylon/Rebar will have many more performance options, such as making fluid pipes tick less often, or reducing tick rates of individual types of machines
77
78
-:gear: We plan to add a purpose-built profiler so you can see exactly what blocks & items are using the most CPU or memory
78
79
79
80
### Stability
80
81
81
82
-:gear: Easily disable any problematic blocks or items
82
-
-:gear:Pylon will refuse to start if it detects any configuration issues
83
+
-:gear:Rebar will refuse to start if it detects any configuration issues
83
84
-:gear: Blocks that throw errors will be safely unloaded
84
85
-:gear: Removing addons is safe, with all the data kept intact and restored if the addon is re-added
85
-
-:gear:Pylon data is stored **in the world data itself** - no need to keep extra backups
86
+
-:gear:Rebar data is stored **in the world data itself** - no need to keep extra backups
86
87
87
88
### Customisation
88
89
@@ -96,38 +97,38 @@ Keep reading to find out more.
96
97
97
98
### Addon development
98
99
99
-
-:gear:Pylon has first-class addon support; all the base content is added using an addon!
100
+
-:gear:Rebar has first-class addon support; Pylon is an addon!
100
101
-:gear: Pylon supports addons written in Kotlin
101
102
-:gear: Blocks, items, recipes, guide pages, fluids, and entities are all easy and intuitive to add
102
-
-:gear: Pylon will have extensive high-level documentation on all the features it has to offer
103
+
-:gear:Rebar/Pylon will have extensive high-level documentation on all the features it has to offer
103
104
104
105
!!! warning "Currently, addon development is not supported due to how rapidly Pylon is still changing."
105
106
106
107
### Examples
107
108
108
-
See the following code to get a feel for how Pylon works:
109
+
See the following code to get a feel for how Rebar/Pylon works:
| 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)|
|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)|
| 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/blob/master/src/main/java/io/github/pylonmc/pylon/recipes/HammerRecipe.java)|
|Pylon English language file |[https://github.com/pylonmc/pylon-base/blob/master/src/main/resources/lang/en.yml](https://github.com/pylonmc/pylon/blob/master/src/main/resources/lang/en.yml)|
|**How do I install Pylon?**| 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.**|
127
-
|**Will Pylon support Slimefun addons?**| 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. |
128
-
|**What versions will Pylon support?**| 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. |
129
-
|**What server software can Pylon run on?**| Paper or paper forks only. Folia support may come later down the line. |
130
-
|**Will Pylon support bedrock (via Geyser)?**| 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. |
127
+
|**How do I install Pylon?**| Read the installation guide at [https://pylonmc.github.io/installation/installing-pylon/](https://pylonmc.github.io/installation/installing-pylon/). Beware that **Pylon and Rebar are still experimental and you should not run them outside of an expendable test server.**|
128
+
|**Will Rebar support Slimefun addons?**| No. Migrating from Slimefun to Rebar 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. |
129
+
|**What versions will Rebar/Pylon support?**| We plan to keep each Pylon and Rebar 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/Rebar will only support one version of Minecraft.** This means you will need to use older versions of Pylon/Rebar for older versions of Minecraft. Critical fixes will be backported. |
130
+
|**What server software can Pylon/Rebar run on?**| Paper or paper forks only. Folia support may come later down the line. |
131
+
|**Will Pylon/Rebar support bedrock (via Geyser)?**| 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. |
131
132
|**When will Pylon be ready?**| See the 'Provisional Timeline' section above |
132
133
|**How can I submit a translation?**| We do not currently accept translations due to how quickly the plugin is changing (any translation would go out of date quickly). There will be an announcement when we are ready for translations. |
0 commit comments