New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added configuration documentation #19
Conversation
Also, I removed the "configuration format" file.
|
|
||
|
||
<p> | ||
In the example above, you can login to the web admin using the username <code>john</code> and the password <code>cuberiteRocks</code> by pointing your browser to <code>http://localhost:8080</code>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Localhost should probably be the IP of the server. I think there's a section for finding that.
Thanks for this. Looks good apart from the one thing. |
Done. Shall I squash? |
|
||
<p> | ||
After downloading a plugin, you need to put it in the <code>plugins/</code> directory. | ||
You should then edit the `plugins` sections of the `settings.ini` file and add a plugin entry there. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Markdown alert :P
Added configuration documentation
Thanks! |
I was still pushing changes :P |
Np, stay tuned for a minor PR. |
I added some really needed documentation.
I also made a structural change. It is explained below.
The
4 - plugins
section was moved into2 - configuration basics
. The rationale behind this is that now, everything config-related a beginner needs can be found inconfiguration basics
, Namely: Overview of config, setting up WebAdmin, setting up worlds, setting up plugins.The idea is that everything is now explained briefly in
2 - configuration basics
and some stuff would have their own in-depth sections. In the future, we can have aplugins
section explaining plugins in detail, and asettings.ini
section explaining that file in detail, just like3 - Configuring world.ini
,