Skip to content

Commit

Permalink
some documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
plun1331 committed Dec 16, 2021
1 parent 912fecf commit f6c6bac
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 8 deletions.
6 changes: 4 additions & 2 deletions plugins/creating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
20 changes: 19 additions & 1 deletion server/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
14 changes: 9 additions & 5 deletions server/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -64,7 +69,7 @@ To update your server, simply re-clone our `GitHub Repository <https://github.co
or download it as a zip and extract it to a location on your system.

You can then update your requirements by running one of the the
following commands in your server's root directory:
following commands:

.. code:: sh
Expand All @@ -73,4 +78,3 @@ following commands in your server's root directory:
# Windows
py -3 -m pip install -U -r requirements.txt

0 comments on commit f6c6bac

Please sign in to comment.