From f6c6bace65db24b230caf3543d5eab95abcca740 Mon Sep 17 00:00:00 2001 From: plun1331 Date: Wed, 15 Dec 2021 21:17:01 -0800 Subject: [PATCH] some documentation changes --- plugins/creating.rst | 6 ++++-- server/configuration.rst | 20 +++++++++++++++++++- server/getting-started.rst | 14 +++++++++----- 3 files changed, 32 insertions(+), 8 deletions(-) diff --git a/plugins/creating.rst b/plugins/creating.rst index fa1d4f1..ea78d48 100644 --- a/plugins/creating.rst +++ b/plugins/creating.rst @@ -16,7 +16,8 @@ To start, create an ``info.json`` file. It should look something like this: "main": "main.Main", // Your plugin's main class. "version": "0.0.1", // Your plugin's version. "description": "Plugin Description", // Your plugin's description. - "author": "Plugin Author" // The plugin's author. + "author": "Plugin Author", // The plugin's author. + "required_plugins": ["plugin1", "plugin2"], // A list of plugins that are required by your plugin. } Now, it's time to start coding. @@ -36,4 +37,5 @@ Your plugin's ``Main`` class can have 2 methods that are used by the server, Each method is called when the plugin is loaded/unloaded respectively. - +To add a plugin to the server, simply compress the plugin files in the form of a +``.zip`` or a ``.pyz`` file and place it in the ``plugins`` directory. diff --git a/server/configuration.rst b/server/configuration.rst index 330a86e..914e887 100644 --- a/server/configuration.rst +++ b/server/configuration.rst @@ -36,7 +36,7 @@ max_players max_view_distance ****************** -* **default**: ``8`` +* **default**: ``2`` * **description**: Sets a player's maximum view distance, in chunks. world_provider @@ -50,3 +50,21 @@ world_name * **default**: world * **description**: Sets the default world name. + +world_type +****************** + +* **default**: default +* **description**: Sets the default world type. + +seed +****************** + +* **default**: ``421086205`` +* **description**: Sets the world's seed. + +difficulty +****************** + +* **default**: ``0`` +* **description**: The server's difficulty. diff --git a/server/getting-started.rst b/server/getting-started.rst index 762c9a3..f2d7d37 100644 --- a/server/getting-started.rst +++ b/server/getting-started.rst @@ -39,21 +39,26 @@ by running one of the the following commands in your server's root directory: py -3 -m pip install -U -r requirements.txt +.. note:: + Please note for linux you may need to install the following packages before running the above commands: + + * ``python-dev`` (e.g. ``python3.6-dev`` for Python 3.6) + .. _running: Running the Server ******************* To run the server, run one of the the following -commands in your server's root directory: +commands: .. code:: sh # Linux/macOS - python3 __main__.py + python3 run.py # Windows - py -3 __main__.py + py -3 run.py .. _updating: @@ -64,7 +69,7 @@ To update your server, simply re-clone our `GitHub Repository