mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
Restructure starting tut
This commit is contained in:
parent
47d168219c
commit
979aa924dd
11 changed files with 107 additions and 89 deletions
|
|
@ -3,22 +3,20 @@
|
|||
|
||||
### How to *get* Help
|
||||
|
||||
If you cannot find what you are looking for in the [online documentation]([online
|
||||
documentation](index)), here's what to do:
|
||||
If you cannot find what you are looking for in the
|
||||
[online documentation](index), here's what to do:
|
||||
|
||||
- If you think the documentation is not clear enough and are short on time, fill in our quick little
|
||||
[online form][form] and let us know - no login required. Maybe the docs need to be improved or a new
|
||||
tutorial added! Note that while this form is useful as a suggestion box we cannot answer questions
|
||||
or reply to you. Use the discussion group or chat (linked below) if you want feedback.
|
||||
- If you have trouble with a missing feature or a problem you think is a bug, go to the [issue
|
||||
tracker][issues] and search to see if has been reported/suggested already. If you can't find an
|
||||
existing entry create a new one.
|
||||
- If you think the documentation is not clear enough, create a [documentation ticket](issue).
|
||||
- If you have trouble with a missing feature or a problem you think is a bug, look through the
|
||||
the list of known [issue][issues] if you can't find your issue in the list, make a
|
||||
new one [here](bug-report).
|
||||
- If you need help, want to start a discussion or get some input on something you are working on,
|
||||
make a post to the [discussions group][group] This is technically a 'mailing list', but you don't
|
||||
need to use e-mail; you can post and read all messages just as easily from your browser via the
|
||||
online interface.
|
||||
- If you want more direct discussions with developers and other users, consider dropping into our
|
||||
IRC chat channel [#evennia][chat] on the *Freenode* network. Please note however that you have to be
|
||||
IRC chat channel [#evennia][chat] on the *Freenode* network. There is also a Discord channel
|
||||
bridged into the IRC if you prefer that. Please that you have to be
|
||||
patient if you don't get any response immediately; we are all in very different time zones and many
|
||||
have busy personal lives. So you might have to hang around for a while - you'll get noticed
|
||||
eventually!
|
||||
|
|
@ -26,46 +24,43 @@ eventually!
|
|||
|
||||
### How to *give* Help
|
||||
|
||||
Evennia is a completely non-funded project. It relies on the time donated by its users and
|
||||
developers in order to progress.
|
||||
Evennia is open-source and non-commercial. It relies on the time donated by its users and developers in order to progress.
|
||||
|
||||
The first and easiest way you as a user can help us out is by taking part in [community
|
||||
discussions][group] and by giving feedback on what is good or bad. Report bugs you find and features
|
||||
you lack to our [issue tracker][issues]. Just the simple act of letting developers know you are out
|
||||
there using their program is worth a lot. Generally mentioning and reviewing Evennia elsewhere is
|
||||
also a nice way to spread the word.
|
||||
- Spread the word! If you like Evennia, consider writing a blog post about it.
|
||||
- Take part in the Evennia community! Join the [chat][chat] or [forum][group].
|
||||
- Report problems you find or features you'd like to our [issue tracker](issues).
|
||||
|
||||
```important::
|
||||
Just the simple act of letting developers know you are out there using their program helps a lot.
|
||||
```
|
||||
|
||||
If you'd like to help develop Evennia more hands-on, here are some ways to get going:
|
||||
|
||||
- Look through our [online documentation wiki]([online documentation wiki](index)) and see if you
|
||||
can help improve or expand the documentation (even small things like fixing typos!). You don't need
|
||||
any particular permissions to edit the wiki.
|
||||
- Look through this [online documentation](index) and see if you can help improve or expand the
|
||||
documentation (even small things like fixing typos!). [See here](Contributing-Docs) on how you
|
||||
contribute to the docs.
|
||||
- Send a message to our [discussion group][group] and/or our [IRC chat][chat] asking about what
|
||||
needs doing, along with what your interests and skills are.
|
||||
- Take a look at our [issue tracker][issues] and see if there's something you feel like taking on.
|
||||
[here are bugs][issues-master] that need fixes. At any given time there may also be some
|
||||
[bounties][issues-bounties] open - these are issues members of the community has put up money to see
|
||||
fixed (if you want to put up a bounty yourself you can do so via our page on
|
||||
[bountysource][bountysource]).
|
||||
[bounties][issues-bounties] open.
|
||||
- Check out the [Contributing](Contributing) page on how to practically contribute with code using
|
||||
github.
|
||||
|
||||
... And finally, if you want to help motivate and support development you can also drop some coins
|
||||
in the developer's cup. You can [make a donation via PayPal][paypal] or, even better, [become an
|
||||
Evennia patron on Patreon][patreon]! This is a great way to tip your hat and show that you
|
||||
appreciate the work done with the server! Finally, if you want to encourage the community to resolve
|
||||
a particular
|
||||
appreciate the work done with the server! You can also encourage the community to take on particular
|
||||
issues by putting up a monetary [bounty][bountysource] on it.
|
||||
|
||||
|
||||
[form]: https://docs.google.com/spreadsheet/viewform?hl=en_US&formkey=dGN0VlJXMWpCT3VHaHpscDEzY1RoZGc6MQ#gid=0
|
||||
[group]: http://groups.google.com/group/evennia/
|
||||
[issues]: https://github.com/evennia/evennia/issues
|
||||
[issues-master]: https://github.com/evennia/evennia/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3Abug%20label%3Amaster-
|
||||
branch
|
||||
[issues-master]: https://github.com/evennia/evennia/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3Abug%20label%3Amaster-branch
|
||||
[chat]: http://webchat.freenode.net/?channels=evennia
|
||||
[paypal]: https://www.paypal.com/se/cgi-
|
||||
bin/webscr?cmd=_flow&SESSION=Z-VlOvfGjYq2qvCDOUGpb6C8Due7skT0qOklQEy5EbaD1f0eyEQaYlmCc8O&dispatch=5885d80a13c0db1f8e263663d3faee8d64ad11bbf4d2a5a1a0d303a50933f9b2
|
||||
[donate-img]: http://images-focus-
|
||||
opensocial.googleusercontent.com/gadgets/proxy?url=https://www.paypalobjects.com/en%255fUS/SE/i/btn/btn%255fdonateCC%255fLG.gif&container=focus&gadget=a&rewriteMime=image/*
|
||||
[paypal]: https://www.paypal.com/se/cgi-bin/webscr?cmd=_flow&SESSION=Z-VlOvfGjYq2qvCDOUGpb6C8Due7skT0qOklQEy5EbaD1f0eyEQaYlmCc8O&dispatch=5885d80a13c0db1f8e263663d3faee8d64ad11bbf4d2a5a1a0d303a50933f9b2
|
||||
[donate-img]: http://images-focus-opensocial.googleusercontent.com/gadgets/proxy?url=https://www.paypalobjects.com/en%255fUS/SE/i/btn/btn%255fdonateCC%255fLG.gif&container=focus&gadget=a&rewriteMime=image/*
|
||||
[patreon]: https://www.patreon.com/griatch
|
||||
[patreon-img]: http://www.evennia.com/_/rsrc/1424724909023/home/evennia_patreon_100x100.png
|
||||
[issues-bounties]: https://github.com/evennia/evennia/labels/bounty
|
||||
|
|
|
|||
|
|
@ -1,60 +1,64 @@
|
|||
# Tutorials and Howto's
|
||||
|
||||
The documents in this section aims to teach how to use Evennia in a tutorial or
|
||||
a step-by-step way. They often give hints on about solving a problem or implementing
|
||||
a particular feature or concept. They will often refer to the
|
||||
[components](Components/Components-Overview) or [concepts](Concepts/Concepts-Overview)
|
||||
a step-by-step way. They often give hints on about solving a problem or implementing
|
||||
a particular feature or concept. They will often refer to the
|
||||
[components](Components/Components-Overview) or [concepts](Concepts/Concepts-Overview)
|
||||
docs for those that want to dive deeper.
|
||||
|
||||
## The Starting Tutorial
|
||||
## The Starting Tutorial
|
||||
|
||||
Recommended starting point! This will take you from absolute beginner to making
|
||||
a small, but full, game with Evennia. Even if you have a very different game style
|
||||
in mind for your own game, this will give you a good start.
|
||||
a small, but full, game with Evennia. Even if you have a very different game style
|
||||
in mind for your own game, this will give you a good start.
|
||||
|
||||
### Part 1: What we have
|
||||
### Part 1: What we have
|
||||
|
||||
- [Introduction & Overview](Starting/Starting-Introduction)
|
||||
- [Building stuff](Starting/Building-Quickstart)
|
||||
- [Python basics](Starting/Python-basic-introduction)
|
||||
- [Python classes](Starting/Python-basic-tutorial-part-two)
|
||||
- [Running Python in- and outside the game](Starting/Execute-Python-Code)
|
||||
- [Understanding errors](Understanding-Errors)
|
||||
- [Searching for things](Starting/Tutorial-Searching-For-Objects)
|
||||
- [A walkthrough of the API](Walkthrough-of-API)
|
||||
1. [Introduction & Overview](Starting/Starting-Part1)
|
||||
1. [Building stuff](Starting/Building-Quickstart)
|
||||
1. [Python basics](Starting/Python-basic-introduction)
|
||||
1. [Python classes](Starting/Python-basic-tutorial-part-two)
|
||||
1. [Running Python in- and outside the game](Starting/Execute-Python-Code)
|
||||
1. [Understanding errors](Understanding-Errors)
|
||||
1. [Searching for things](Starting/Tutorial-Searching-For-Objects)
|
||||
1. [A walkthrough of the API](Walkthrough-of-API)
|
||||
|
||||
### Part 2: What we want
|
||||
### Part 2: What we want
|
||||
|
||||
- [On planning a game](Starting/Game-Planning)
|
||||
- [Multisession modes](Multi-session-modes)
|
||||
- [Layout of our tutorial game](Game-Tutorial-Planning)
|
||||
- [Making use of contribs](Using-Contribs)
|
||||
1. [Introduction & Overview](Starting/Starting-Part2)
|
||||
1. [On planning a game](Starting/Game-Planning)
|
||||
1. [Multisession modes](Multi-session-modes)
|
||||
1. [Layout of our tutorial game](Game-Tutorial-Planning)
|
||||
1. [Making use of contribs](Using-Contribs)
|
||||
|
||||
### Part3: How we get there
|
||||
### Part 3: How we get there
|
||||
|
||||
- [Where to put code](Starting/First-Steps-Coding)
|
||||
- [Adding a first command](Starting/Adding-Command-Tutorial)
|
||||
- [Parsing strings](Starting/Parsing-command-arguments,-theory-and-best-practices)
|
||||
- [Making a custom Character](Starting/Adding-Object-Typeclass-Tutorial)
|
||||
- [The rules of the game](Starting/Implementing-a-game-rule-system)
|
||||
- [Character generation](Character-Generkation)
|
||||
- [Resolving skills and challenges](Skills-and-Challenges)
|
||||
- [NPCs and mobiles](NPCs-and-Mobiles)
|
||||
- [On grids and coordinates](Starting/Coordinates)
|
||||
- [Quests and Zones](Quests-and-Zones)
|
||||
- [A Combat system](Combat-System)
|
||||
1. [Introduction & Overview](Starting/Starting-Part3)
|
||||
1. [Where to put code](Starting/First-Steps-Coding)
|
||||
1. [Adding a first command](Starting/Adding-Command-Tutorial)
|
||||
1. [Parsing strings](Starting/Parsing-command-arguments,-theory-and-best-practices)
|
||||
1. [Making a custom Character](Starting/Adding-Object-Typeclass-Tutorial)
|
||||
1. [The rules of the game](Starting/Implementing-a-game-rule-system)
|
||||
1. [Character generation](Character-Generkation)
|
||||
1. [Resolving skills and challenges](Skills-and-Challenges)
|
||||
1. [NPCs and mobiles](NPCs-and-Mobiles)
|
||||
1. [On grids and coordinates](Starting/Coordinates)
|
||||
1. [Quests and Zones](Quests-and-Zones)
|
||||
1. [A Combat system](Combat-System)
|
||||
|
||||
### Part4: Using what we created
|
||||
### Part 4: Using what we created
|
||||
|
||||
- [Building the tech demo](Building-the-tech-demo)
|
||||
- [Creating a game world](Creating-a-game-world)
|
||||
1. [Introduction & Overview](Starting/Starting-Part4)
|
||||
1. [Building the tech demo](Building-the-tech-demo)
|
||||
1. [Creating a game world](Creating-a-game-world)
|
||||
|
||||
### Part6: Showing the world
|
||||
### Part 5: Showing the world
|
||||
|
||||
- [Add a web page](Starting/Add-a-simple-new-web-page)
|
||||
- [More on adding web features](Starting/Web-Tutorial)
|
||||
- [Taking your game online](Taking-your-game-online)
|
||||
- [Next steps](Where-to-Go-from-here)
|
||||
1. [Introduction & Overview](Starting/Starting-Part5)
|
||||
1. [Add a web page](Starting/Add-a-simple-new-web-page)
|
||||
1. [More on adding web features](Starting/Web-Tutorial)
|
||||
1. [Taking your game online](Taking-your-game-online)
|
||||
1. [Next steps](Where-to-Go-from-here)
|
||||
|
||||
|
||||
## FAQs
|
||||
|
|
|
|||
|
|
@ -1,3 +0,0 @@
|
|||
# Evennia Starting Tutorial
|
||||
|
||||
This starts your path towards making your own game in Evennia.
|
||||
18
docs/source/Howto/Starting/Starting-Part1.md
Normal file
18
docs/source/Howto/Starting/Starting-Part1.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
# Evennia Starting Tutorial
|
||||
|
||||
This is a multi-part Tutorial that will gradually take you from first installation to making your
|
||||
own first little game in Evennia. Let's get started!
|
||||
|
||||
```sidebar:: Parts of the Starting tutorial
|
||||
|
||||
**Part 1**: What we have:
|
||||
A tour of Evennia and how to use the tools, including an introduction to Python.
|
||||
[Part 2: What we want](Starting-Part2):
|
||||
Planning our tutorial game and what to think about when planning your own in the future.
|
||||
[Part 3: How we get there](Starting-Part3):
|
||||
Getting down to the meat of extending Evennia to make our game
|
||||
[Part 4: Using what we created](Starting-Part4):
|
||||
Building a tech-demo and world content to go with our code
|
||||
[Part 5: Showing the world](Starting-Part5):
|
||||
Taking our new game online and let players try it out
|
||||
```
|
||||
0
docs/source/Howto/Starting/Starting-Part2.md
Normal file
0
docs/source/Howto/Starting/Starting-Part2.md
Normal file
0
docs/source/Howto/Starting/Starting-Part3.md
Normal file
0
docs/source/Howto/Starting/Starting-Part3.md
Normal file
0
docs/source/Howto/Starting/Starting-Part4.md
Normal file
0
docs/source/Howto/Starting/Starting-Part4.md
Normal file
0
docs/source/Howto/Starting/Starting-Part5.md
Normal file
0
docs/source/Howto/Starting/Starting-Part5.md
Normal file
|
|
@ -1,9 +1,9 @@
|
|||
{%- extends "!layout.html" %}
|
||||
|
||||
{% if next %}
|
||||
<a href="{{ next.link|e }}">{{ next.title }}</a>
|
||||
{% endif %}
|
||||
|
||||
{% if prev %}
|
||||
<a href="{{ prev.link|e }}">{{ prev.title }}</a>
|
||||
{% endif %}
|
||||
{% block footer %}
|
||||
|
||||
{{ super() }}
|
||||
The value of next is {{ next }}.
|
||||
|
||||
{% endblock %}
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
This is the **experimental** and **unstable** documentation for the
|
||||
development branch of Evennia (v1.0-dev). It's based on converted docs
|
||||
from the Evennia wiki (https://github.com/evennia/evennia/wiki/) at
|
||||
2020-06-12 22:36:53. There are known conversion issues and missing links.
|
||||
2020-06-12 22:36:53. There are known conversion issues and missing links.
|
||||
This will slowly be ironed out as this is developed.
|
||||
|
||||
For now you are best off using the original wiki, or the less changing v0.9.1
|
||||
|
|
@ -14,20 +14,20 @@
|
|||
# Evennia Documentation
|
||||
|
||||
This is the manual of [Evennia](http://www.evennia.com), the open source Python
|
||||
`MU*` creation system.
|
||||
`MU*` creation system.
|
||||
|
||||
- [Evennia Introduction](Evennia-Introduction)
|
||||
- [Install & Setup Quickstart](Setup/Setup-Quickstart)
|
||||
- [Begin the starting tutorial](Howto/Starting/Starting-Introduction)
|
||||
- [How to get help](How-To-Get-And-Give-Help)
|
||||
- [Begin the starting tutorial](Howto/Starting/Starting-Part1)
|
||||
- [How to get (and give) help](How-To-Get-And-Give-Help)
|
||||
|
||||
## Main sections
|
||||
## Main sections
|
||||
|
||||
- [Server Setup, Maintenance and Life](Setup/Setup-Overview) - how to run, maintain and release
|
||||
- [Server Setup, Maintenance and Life](Setup/Setup-Overview) - how to run, maintain and release
|
||||
- [Tutorials and Howto's](Howto/Howto-Overview) - projects and hints for reaching particular effects and goals
|
||||
- [Core components](Component/Component-Overview) - the core building blocks of Evennia
|
||||
- [Concepts](Concept/Concept-Overview) - larger-scale concepts and features
|
||||
- [Coding](Coding/Coding-Overview) - coding and development hints and resources
|
||||
- [Concepts](Concept/Concept-Overview) - larger-scale concepts and features
|
||||
- [Coding](Coding/Coding-Overview) - coding and development hints and resources
|
||||
- [Contributions](Contrib/Contrib-Overview) - game-specific tools and code added by the community
|
||||
- [API](Evennia-API) - the full API-reference, generated from source
|
||||
- [Table of Contents](toc) - an alphabetical listing of all regular documentation pages
|
||||
|
|
|
|||
|
|
@ -105,7 +105,11 @@
|
|||
- [Howto/Starting/Parsing command arguments, theory and best practices](Howto/Starting/Parsing-command-arguments,-theory-and-best-practices)
|
||||
- [Howto/Starting/Python basic introduction](Howto/Starting/Python-basic-introduction)
|
||||
- [Howto/Starting/Python basic tutorial part two](Howto/Starting/Python-basic-tutorial-part-two)
|
||||
- [Howto/Starting/Starting Introduction](Howto/Starting/Starting-Introduction)
|
||||
- [Howto/Starting/Starting Part1](Howto/Starting/Starting-Part1)
|
||||
- [Howto/Starting/Starting Part2](Howto/Starting/Starting-Part2)
|
||||
- [Howto/Starting/Starting Part3](Howto/Starting/Starting-Part3)
|
||||
- [Howto/Starting/Starting Part4](Howto/Starting/Starting-Part4)
|
||||
- [Howto/Starting/Starting Part5](Howto/Starting/Starting-Part5)
|
||||
- [Howto/Starting/Turn based Combat System](Howto/Starting/Turn-based-Combat-System)
|
||||
- [Howto/Starting/Tutorial Searching For Objects](Howto/Starting/Tutorial-Searching-For-Objects)
|
||||
- [Howto/Starting/Tutorial for basic MUSH like game](Howto/Starting/Tutorial-for-basic-MUSH-like-game)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue