Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaythebusinessgoose committed Oct 8, 2021
1 parent f49f0a9 commit 1ca13c3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Like the CustomLevels tool, the level loading supports levels of any size up to

Each room must be created as a setroom template with the format `setroomy_x`. This is slightly different from the `setroomy-x` that the game uses for setrooms.

### Examples

For some examples of how to use the LevelSequence tool, see:
* [ExampleKaizo](https://github.com/jaythebusinessgoose/ExampleKaizo) \
A simple example of how to format the level files and how to set up the sequence.
* [JumpLunky](https://github.com/jaythebusinessgoose/JumpLunky) \
A full mod that uses more advanced features of LevelSequence.

### Configuration

Due to the way level files are loaded in, some extra configuration is required if the LevelSequence package is relocated. If it is anywhere other than the root directory of the mod, or has a name other than LevelSequence, `set_directory` must be called, passing the path to the directory within the mod folder including the directory name. Eg, for `MyCoolMod/SweetFolder/LevelSequence/level_sequence.lua` call `level_sequence.set_directory('SweetFolder/LevelSequence')`.
Expand Down

0 comments on commit 1ca13c3

Please sign in to comment.