Refactor 1.0 docs with new toctree structure and inheritance
This commit is contained in:
Griatch
parent
62477eac50
commit
628afe9367
142 changed files with 3967 additions and 3024 deletions
|
|
@ -29,7 +29,7 @@ of storage space on S3, making the current total cost of running this plugin
|
|||
them to many users, caveat emptor on a total cost of ownership - check AWS's
|
||||
pricing structure.
|
||||
|
||||
# Technical details
|
||||
## Technical details
|
||||
|
||||
This is a drop-in replacement that operates deeper than all of Evennia's code,
|
||||
so your existing code does not need to change at all to support it.
|
||||
|
|
@ -52,9 +52,9 @@ other contributions or custom code. Simply work how you would normally, Django
|
|||
will handle the rest.
|
||||
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
## Set up AWS account
|
||||
### Set up AWS account
|
||||
|
||||
If you don't have an AWS S3 account, you should create one at
|
||||
https://aws.amazon.com/ - documentation for AWS S3 is available at:
|
||||
|
|
@ -161,7 +161,7 @@ checking the source of any image (for instance, the logo). It should read
|
|||
`https://your-bucket-name.s3.amazonaws.com/path/to/file`. If so, the system
|
||||
works and you shouldn't need to do anything else.
|
||||
|
||||
# Uninstallation
|
||||
## Uninstallation
|
||||
|
||||
If you haven't made changes to your static files (uploaded images, etc),
|
||||
you can simply remove the lines you added to `secret_settings.py`. If you
|
||||
|
|
@ -170,7 +170,7 @@ your files from your S3 bucket and put them in /static/ in the evennia
|
|||
directory.
|
||||
|
||||
|
||||
# License
|
||||
## License
|
||||
|
||||
Draws heavily from code provided by django-storages, for which these contributors
|
||||
are authors:
|
||||
|
|
@ -221,6 +221,6 @@ Andrew Perry (Bug fixes in SFTPStorage)
|
|||
The repurposed code from django-storages is released under BSD 3-Clause,
|
||||
same as Evennia, so for detailed licensing, refer to the Evennia license.
|
||||
|
||||
# Versioning
|
||||
## Versioning
|
||||
|
||||
This is confirmed to work for Django 2 and Django 3.
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -1,9 +1,9 @@
|
|||
# Color markups
|
||||
# Additional Color markups
|
||||
|
||||
Contrib by Griatch, 2017
|
||||
|
||||
Additional color markup styles for Evennia (extending or replacing the default
|
||||
`|r`, `|234`). Adds support for MUSH-style (`%cr`, `%c123`) and/or legacy-Evennia
|
||||
`|r`, `|234`). Adds support for MUSH-style (`%cr`, `%c123`) and/or legacy-Evennia
|
||||
(`{r`, `{123`).
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
Contrib by vlgeoff, 2017 - based on Griatch's core original
|
||||
|
||||
This reimplements the `evennia.utils.gametime` module but with a _custom_
|
||||
calendar (unusual number of days per week/month/year etc) for your game world.
|
||||
calendar (unusual number of days per week/month/year etc) for your game world.
|
||||
Like the original, it allows for scheduling events to happen at given
|
||||
in-game times, but now taking this custom calendar into account.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
Contrib by Griatch, 2012
|
||||
|
||||
This is a variant of the login system that asks for an email-address
|
||||
instead of a username to login. Note that it does not verify the email,
|
||||
instead of a username to login. Note that it does not verify the email,
|
||||
it just uses it as the identifier rather than a username.
|
||||
|
||||
This used to be the default Evennia login before replacing it with a
|
||||
|
|
|
|||
|
|
@ -893,3 +893,12 @@ EVENTS_DISABLED = True
|
|||
|
||||
The in-game Python system will still be accessible (you will have access to the `call` command, to debug),
|
||||
but no event will be called automatically.
|
||||
|
||||
|
||||
```{toctree}
|
||||
:hidden:
|
||||
|
||||
Contrib-Ingame-Python-Tutorial-Dialogue
|
||||
Contrib-Ingame-Python-Tutorial-Elevator
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
# Unix-like Command style parent
|
||||
# Unix-like Command style
|
||||
|
||||
Contribution by Vincent Le Geoff (vlgeoff), 2017
|
||||
|
||||
This module contains a command class with an alternate syntax parser implementing
|
||||
Unix-style command syntax in-game. This means `--options`, positional arguments
|
||||
This module contains a command class with an alternate syntax parser implementing
|
||||
Unix-style command syntax in-game. This means `--options`, positional arguments
|
||||
and stuff like `-n 10`. It might not the best syntax for the average player
|
||||
but can be really useful for builders when they need to have a single command do
|
||||
many things with many options. It uses the `ArgumentParser` from Python's standard
|
||||
|
|
|
|||
|
|
@ -2,10 +2,10 @@
|
|||
|
||||
Contribution by Griatch, 2019
|
||||
|
||||
A full engine for creating multiplayer escape-rooms in Evennia. Allows players to
|
||||
spawn and join puzzle rooms that track their state independently. Any number of players
|
||||
can join to solve a room together. This is the engine created for 'EvscapeRoom', which won
|
||||
the MUD Coders Guild "One Room" Game Jam in April-May, 2019. The contrib has no game
|
||||
A full engine for creating multiplayer escape-rooms in Evennia. Allows players to
|
||||
spawn and join puzzle rooms that track their state independently. Any number of players
|
||||
can join to solve a room together. This is the engine created for 'EvscapeRoom', which won
|
||||
the MUD Coders Guild "One Room" Game Jam in April-May, 2019. The contrib has no game
|
||||
content but contains the utilities and base classes and an empty example room.
|
||||
|
||||
The original code for the contest is found at
|
||||
|
|
@ -16,13 +16,13 @@ instead. A copy of the full game can also be played on the Evennia demo server
|
|||
at https://demo.evennia.com - just connect to the server and write `evscaperoom`
|
||||
in the first room to start!
|
||||
|
||||
# Introduction
|
||||
## Introduction
|
||||
|
||||
Evscaperoom is, as it sounds, an escaperoom in text form. You start locked into
|
||||
a room and have to figure out how to get out. This engine contains everything
|
||||
needed to make a fully-featured puzzle game of this type!
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
The Evscaperoom is installed by adding the `evscaperoom` command to your
|
||||
character cmdset. When you run that command in-game you're ready to play!
|
||||
|
|
@ -44,7 +44,7 @@ class CharacterCmdSet(...):
|
|||
Reload the server and the `evscaperoom` command will be available. The contrib
|
||||
comes with a small (very small) escape room as an example.
|
||||
|
||||
# Making your own evscaperoom
|
||||
## Making your own evscaperoom
|
||||
|
||||
To do this, you need to make your own states. First make sure you can play the
|
||||
simple example room installed above.
|
||||
|
|
@ -63,7 +63,7 @@ the following to your `mygame/server/conf/settings.py` file:
|
|||
Reload and the example evscaperoom should still work, but you can now modify and
|
||||
expand it from your game dir!
|
||||
|
||||
## Other useful settings
|
||||
### Other useful settings
|
||||
|
||||
There are a few other settings that may be useful:
|
||||
|
||||
|
|
@ -74,7 +74,7 @@ There are a few other settings that may be useful:
|
|||
the room without an argument. The original is found at the top of
|
||||
`evennia/contrib/full_systems/evscaperoom/commands.py`.
|
||||
|
||||
# Playing the game
|
||||
## Playing the game
|
||||
|
||||
You should start by `look`ing around and at objects.
|
||||
|
||||
|
|
@ -87,7 +87,7 @@ focus.
|
|||
|
||||
There is also a full hint system.
|
||||
|
||||
# Technical
|
||||
## Technical
|
||||
|
||||
When connecting to the game, the user has the option to join an existing room
|
||||
(which may already be in some state of ongoing progress), or may create a fresh
|
||||
|
|
@ -102,7 +102,7 @@ the logic and (in principle) inject new puzzles later.
|
|||
|
||||
Once no players remain in the room, the room and its state will be wiped.
|
||||
|
||||
# Design Philosophy
|
||||
## Design Philosophy
|
||||
|
||||
Some basic premises inspired the design of this.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@
|
|||
Contribution by owllex, 2021
|
||||
|
||||
Cooldowns are used to model rate-limited actions, like how often a
|
||||
character can perform a given action; until a certain time has passed their
|
||||
command can not be used again. This contrib provides a simple cooldown
|
||||
character can perform a given action; until a certain time has passed their
|
||||
command can not be used again. This contrib provides a simple cooldown
|
||||
handler that can be attached to any typeclass. A cooldown is a lightweight persistent
|
||||
asynchronous timer that you can query to see if a certain time has yet passed.
|
||||
|
||||
|
|
@ -38,7 +38,7 @@ def cooldowns(self):
|
|||
return CooldownHandler(self, db_attribute="cooldowns")
|
||||
```
|
||||
|
||||
# Example
|
||||
## Example
|
||||
|
||||
Assuming you've installed cooldowns on your Character typeclasses, you can use a
|
||||
cooldown to limit how often you can perform a command. The following code
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Contribution by grungies1138 2016
|
|||
|
||||
A simple Brandymail style mail system that uses the `Msg` class from Evennia
|
||||
Core. It has two Commands for either sending mails between Accounts (out of game)
|
||||
or between Characters (in-game). The two types of mails can be used together or
|
||||
or between Characters (in-game). The two types of mails can be used together or
|
||||
on their own.
|
||||
|
||||
- `CmdMail` - this should sit on the Account cmdset and makes the `mail` command
|
||||
|
|
@ -21,22 +21,23 @@ Install one or both of the following (see above):
|
|||
|
||||
- CmdMail (IC + OOC mail, sent between players)
|
||||
|
||||
```python
|
||||
# mygame/commands/default_cmds.py
|
||||
|
||||
from evennia.contrib.game_systems import mail
|
||||
|
||||
# in AccountCmdSet.at_cmdset_creation:
|
||||
self.add(mail.CmdMail())
|
||||
|
||||
```
|
||||
- CmdMailCharacter (optional, IC only mail, sent between characters)
|
||||
|
||||
```python
|
||||
# mygame/commands/default_cmds.py
|
||||
|
||||
from evennia.contrib.game_systems import mail
|
||||
|
||||
# in CharacterCmdSet.at_cmdset_creation:
|
||||
self.add(mail.CmdMailCharacter())
|
||||
|
||||
```
|
||||
Once installed, use `help mail` in game for help with the mail command. Use
|
||||
ic/ooc to switch in and out of IC/OOC modes.
|
||||
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ references to rooms previously created is passed to the build commands.
|
|||
You then call the command in-game using the path to the MAP and MAP_LEGEND vars
|
||||
The path you provide is relative to the evennia or mygame folder.
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
Use by importing and including the command in your default_cmdsets module.
|
||||
For example:
|
||||
|
|
@ -68,14 +68,14 @@ For example:
|
|||
```
|
||||
|
||||
|
||||
# Usage:
|
||||
## Usage:
|
||||
|
||||
mapbuilder[/switch] <path.to.file.MAPNAME> <path.to.file.MAP_LEGEND>
|
||||
|
||||
one - execute build instructions once without automatic exit creation.
|
||||
two - execute build instructions twice without automatic exit creation.
|
||||
|
||||
# Examples
|
||||
## Examples
|
||||
|
||||
mapbuilder world.gamemap.MAP world.maplegend.MAP_LEGEND
|
||||
mapbuilder evennia.contrib.grid.mapbuilder.EXAMPLE1_MAP EXAMPLE1_LEGEND
|
||||
|
|
@ -86,7 +86,7 @@ Below are two examples showcasing the use of automatic exit generation and
|
|||
custom exit generation. Whilst located, and can be used, from this module for
|
||||
convenience The below example code should be in mymap.py in mygame/world.
|
||||
|
||||
## Example One
|
||||
### Example One
|
||||
|
||||
```python
|
||||
|
||||
|
|
@ -190,7 +190,7 @@ EXAMPLE1_LEGEND = {
|
|||
}
|
||||
```
|
||||
|
||||
## Example Two
|
||||
### Example Two
|
||||
|
||||
```python
|
||||
# @mapbuilder/two evennia.contrib.grid.mapbuilder.EXAMPLE2_MAP EXAMPLE2_LEGEND
|
||||
|
|
|
|||
|
|
@ -315,7 +315,7 @@ def _option_spawn(*suboptions):
|
|||
print("Aborted.")
|
||||
return
|
||||
|
||||
print("Starting spawn ...")
|
||||
print("Beginner-Tutorial spawn ...")
|
||||
grid.spawn(xyz=(x, y, z))
|
||||
print("... spawn complete!\nIt's recommended to reload the server to refresh caches if this "
|
||||
"modified an existing grid.")
|
||||
|
|
|
|||
|
|
@ -1128,7 +1128,7 @@ class BasicMapNode(MapNode):
|
|||
|
||||
class InterruptMapNode(MapNode):
|
||||
"""A point of interest node/room. Pathfinder will ignore but auto-stepper will
|
||||
stop here if passing through. Starting from here is fine."""
|
||||
stop here if passing through. Beginner-Tutorial from here is fine."""
|
||||
symbol = "I"
|
||||
display_symbol = "#"
|
||||
interrupt_path = True
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
# Dice
|
||||
# Dice roller
|
||||
|
||||
Contribution by Griatch, 2012
|
||||
|
||||
A dice roller for any number and side of dice. Adds in-game dice rolling
|
||||
(`roll 2d10 + 1`) as well as conditionals (roll under/over/equal to a target)
|
||||
and functions for rolling dice in code. Command also supports hidden or secret
|
||||
A dice roller for any number and side of dice. Adds in-game dice rolling
|
||||
(`roll 2d10 + 1`) as well as conditionals (roll under/over/equal to a target)
|
||||
and functions for rolling dice in code. Command also supports hidden or secret
|
||||
rolls for use by a human game master.
|
||||
|
||||
|
||||
# Installation:
|
||||
## Installation:
|
||||
|
||||
|
||||
Add the `CmdDice` command from this module to your character's cmdset
|
||||
|
|
@ -28,7 +28,7 @@ class CharacterCmdSet(default_cmds.CharacterCmdSet):
|
|||
|
||||
```
|
||||
|
||||
# Usage:
|
||||
## Usage:
|
||||
|
||||
> roll 1d100 + 2
|
||||
> roll 1d20
|
||||
|
|
@ -53,7 +53,7 @@ was.
|
|||
|
||||
Is a hidden roll that does not inform the room it happened.
|
||||
|
||||
## Rolling dice from code
|
||||
### Rolling dice from code
|
||||
|
||||
To roll dice in code, use the `roll` function from this module:
|
||||
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@
|
|||
Contribution by Tim Ashley Jenkins, 2017
|
||||
|
||||
The function provided in this module lets you easily display visual
|
||||
bars or meters as a colorful bar instead of just a number. A "health bar"
|
||||
is merely the most obvious use for this, but the bar is highly customizable
|
||||
bars or meters as a colorful bar instead of just a number. A "health bar"
|
||||
is merely the most obvious use for this, but the bar is highly customizable
|
||||
and can be used for any sort of appropriate data besides player health.
|
||||
|
||||
Today's players may be more used to seeing statistics like health,
|
||||
|
|
|
|||
|
|
@ -697,12 +697,12 @@ Evennia you are wise to take a look at the |wEvennia documentation|n at
|
|||
- The tutorial-world may or may not be your cup of tea, but it does show off
|
||||
several |wuseful tools|n of Evennia. You may want to check out how it works:
|
||||
|
||||
|yhttps://www.evennia.com/docs/latest/Howto/Starting/Part1/Tutorial-World|n
|
||||
|yhttps://www.evennia.com/docs/latest/Howtos/Beginner-Tutorial/Part1/Tutorial-World|n
|
||||
|
||||
- You can then continue looking through the |wTutorials|n and pick one that
|
||||
fits your level of understanding.
|
||||
|
||||
|yhttps://www.evennia.com/docs/latest/Howto/Howto-Overview|n
|
||||
|yhttps://www.evennia.com/docs/latest/Howtos/Howtos-Overview|n
|
||||
|
||||
- Make sure to |wjoin our forum|n and connect to our |wsupport chat|n! The
|
||||
Evennia community is very active and friendly and no question is too simple.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue