Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update source files

Browse source
This commit is contained in:
Griatch 2020-05-18 23:54:21 +02:00
parent c93a91fa5c
commit b1dd8a38a3
4 changed files with 16 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/source/Contributing.md
View file

@ -37,7 +37,7 @@ We always need more eyes and hands on the code. Even if you don't feel confident
and reporting when stuff doesn't make sense helps us a lot.
The most elegant way to contribute code to Evennia is to use GitHub to create a *fork* of the
Evennia repository and make your changes to that. Refer to the [Forking Evennia][forking] version
Evennia repository and make your changes to that. Refer to the [Forking Evennia](https://github.com/evennia/evennia/wiki/Version-Control#forking-evennia) version
control instructions for detailed instructions.
Once you have a fork set up, you can not only work on your own game in a separate branch, you can

3
docs/source/IRC.md
View file

@ -1,5 +1,8 @@
# IRC
_Disambiguation: This page is related to using IRC inside an Evennia game. To join the official Evennia IRC chat, connect to irc.freenode.net and join #evennia. Alternatively, you can [join our Discord](https://discord.gg/NecFePw), which is mirrored to IRC._
[](Connecting-your-game-to-an-external-IRC-channel.)
[IRC (Internet Relay Chat)](http://en.wikipedia.org/wiki/Internet_Relay_Chat) is a long standing chat protocol used by many open-source projects for communicating in real time. By connecting one of Evennia's [Channels](Communications) to an IRC channel you can communicate also with people not on an mud themselves. You can also use IRC if you are only running your Evennia MUD locally on your computer (your game doesn't need to be open to the public)! All you need is an internet connection. For IRC operation you also need [twisted.words](http://twistedmatrix.com/trac/wiki/TwistedWords). This is available simply as a package *python-twisted-words* in many Linux distros, or directly downloadable from the link.

2
docs/source/Start-Stop-Reload.md
View file

@ -89,7 +89,7 @@ From in-game the `@reset` command is used. From the terminal:
## Rebooting
This will shut down *both* Server and Portal, which means all connected players will loose their
This will shut down *both* Server and Portal, which means all connected players will lose their
connection. It can only be initiated from the terminal:
evennia reboot

19
docs/source/index.md
View file

@ -1,3 +1,5 @@
# Home
# Evennia Documentation
This is the manual of [Evennia](http://www.evennia.com), the open source Python `MU*` creation system.
@ -9,15 +11,16 @@ suggestion box][form]!
There is [a lengthier introduction](Evennia-Introduction) to read. You might also want to read about
[how to get and give help](how-to-get-and-give-help).
# Index
| [![Getting Started][icon_new]](Getting-Started)| [![Admin Docs][icon_admin]](Administrative-Docs) | [![Builder Docs][icon_builder]](Builder-Docs) | [![Developer-Central][icon_devel]](Developer-Central) | [![tutorial][icon_tutorial]](Tutorials) | [![API][icon_API]](evennia) |
|-----------------|----------------------|--------------------------|----------------------|----------------------------|--------------------|
|[Getting Started](Getting-Started)| [Admin Docs](Administrative-Docs) | [Builder Docs](Builder-Docs) | [Developer Central](Developer-Central) | [Tutorials & Examples](Tutorials) | [API](evennia) |
* [Getting Started](Getting-Started) page helps installing and starting Evennia for the first time.
* [Admin Docs](Administrative-Docs) covers running and maintaining an Evennia server.
* [Builder Docs](Builder-Docs) helps for starting to build a game world using Evennia.
* [Developer Central](Developer-Central) describes how Evennia works and is used by coders.
* [Tutorials & Examples](Tutorials) contains help pages on a step-by-step or tutorial format.
* [API](api/evennia-api) documentation is created from the latest source code.
* [Document index](toc)
- The [Getting Started](Getting-Started) page helps installing and starting Evennia for the first time.
- The [Admin Docs](Administrative-Docs) covers running and maintaining an Evennia server.
- The [Builder Docs](Builder-Docs) helps for starting to build a game world using Evennia.
- The [Developer Central](Developer-Central) describes how Evennia works and is used by coders.
- The [Tutorials & Examples](Tutorials) contains help pages on a step-by-step or tutorial format.
- The [API](evennia) documentation is created from the latest source code.
[search]: https://www.google.com/cse/publicurl?cx=010440404980795145992:6ztkvqc46je
[group]: https://groups.google.com/forum/#%21forum/evennia