mirror of
https://github.com/itzg/docker-minecraft-server.git
synced 2026-07-15 21:14:54 +00:00
docs: collapse deprecated sections (#2151)
This commit is contained in:
@@ -5,11 +5,8 @@
|
|||||||
[](https://github.com/itzg/docker-minecraft-server/actions)
|
[](https://github.com/itzg/docker-minecraft-server/actions)
|
||||||
[](https://www.buymeacoffee.com/itzg)
|
[](https://www.buymeacoffee.com/itzg)
|
||||||
|
|
||||||
---
|
## [View the full documentation](https://docker-minecraft-server.readthedocs.io/)
|
||||||
|
|
||||||
## [View the documentation](https://itzg.github.io/docker-minecraft-docs/)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Intro
|
## Intro
|
||||||
|
|
||||||
@@ -31,6 +28,9 @@ where, in this case, the standard server port 25565, will be exposed on your hos
|
|||||||
|
|
||||||
By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](#versions) and the [`TYPE`](#server-types) can be configured to create many variations of desired Minecraft server.
|
By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](#versions) and the [`TYPE`](#server-types) can be configured to create many variations of desired Minecraft server.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Expand to see deprecated docs sections -- soon will be removed</summary>
|
||||||
|
|
||||||
## Looking for a Bedrock Dedicated Server
|
## Looking for a Bedrock Dedicated Server
|
||||||
|
|
||||||
For Minecraft clients running on consoles, mobile, or native Windows, you'll need to
|
For Minecraft clients running on consoles, mobile, or native Windows, you'll need to
|
||||||
@@ -1996,3 +1996,5 @@ To run this image on a RaspberryPi 3 B+, 4, or newer, use any of the image tags
|
|||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
See [Development](DEVELOPMENT.md) and [Building](BUILDING.md).
|
See [Development](DEVELOPMENT.md) and [Building](BUILDING.md).
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|||||||
@@ -2,11 +2,11 @@
|
|||||||
|
|
||||||
Adding a new server `TYPE` can vary due to the complexity of obtaining and configuring each type; however, the addition of any server type includes at least the following steps:
|
Adding a new server `TYPE` can vary due to the complexity of obtaining and configuring each type; however, the addition of any server type includes at least the following steps:
|
||||||
|
|
||||||
1. Copy an existing "start-deploy*" script, such as [start-deployMohist](scripts/start-deployMohist) and rename it accordingly making sure to retain the "start-deploy" prefix
|
1. Copy an existing "start-deploy*" script, such as [start-deployFabric](https://github.com/itzg/docker-minecraft-server/blob/master/scripts/start-deployFabric) and rename it accordingly making sure to retain the "start-deploy" prefix
|
||||||
2. Modify the type-specific behavior between the "start-utils" preamble and the hand-off to `start-setupWorld` at the end of the script
|
2. Modify the type-specific behavior between the "start-utils" preamble and the hand-off to `start-setupWorld` at the end of the script
|
||||||
3. Develop and test the changes using the [iterative process described below](#iterative-script-development)
|
3. Develop and test the changes using the [iterative process described below](#iterative-script-development)
|
||||||
4. Add a case-entry to the `case "${TYPE^^}"` in [start-configuration](scripts/start-configuration)
|
4. Add a case-entry to the `case "${TYPE^^}"` in [start-configuration](https://github.com/itzg/docker-minecraft-server/blob/master/scripts/start-configuration)
|
||||||
5. Add a section to the [README](README.md). It is recommended to copy-modify an existing section to retain a similar wording and level of detail
|
5. Add a section to the [docs](https://github.com/itzg/docker-minecraft-server/tree/master/docs). It is recommended to copy-modify an existing section to retain a similar wording and level of detail
|
||||||
6. [Submit a pull request](https://github.com/itzg/docker-minecraft-server/pulls)
|
6. [Submit a pull request](https://github.com/itzg/docker-minecraft-server/pulls)
|
||||||
|
|
||||||
## Iterative script development
|
## Iterative script development
|
||||||
Reference in New Issue
Block a user