Terminal Supaplex Editor Official Documentation (Work in Progress)

1. About the Documentation
- 1.1. Licensing (Docs)
- 1.2. Contributing
2. What is TSpE?
- 2.1. Licensing (TSpE)
3. How to install TSpE

1. About the Documentation

The page/document you are currently looking at is the Official Documentation for Terminal Supaplex Editor a.k.a. TSpE. It, along with the software itself, is made primarily by Matthew (MF366) using Org Mode on Emacs, later exported to HTML.

1.1. Licensing (Docs)

This section is about the LICENSE of this document. For TSpE’s LICENSE, see section 2.1: Licensing (TSpE).

This documentation is licensed under the GNU Free Documentation License (GFDL). Therefore, all edits, reuses and whatnot of this documentation (valid for both Org and HTML versions of the docs) must comply with GFDL’s terms and conditions.

1.2. Contributing

If you wish to contribute to the documentation, I’d really appreciate it. However, there are some rules and guidelines you must follow:

KISS: Keep It Simple, Stupid. Make sure your changes do not affect the simplicity and readability of the documentation in a negative way.
If it ain’t broken, don’t redesign it. Do not propose changes to how the UI should look, as the current combination of HTML and CSS aims for simplicity, due to the fact it’s very objective.
Editing the HTML export is like painting a screenshot — impressive, but pointless. Make Pull Requests for the Org files, not the HTML ones.
Fixing typos is noble; flooding PRs with them is chaos. Typo squatting is perfectly fine and helpful, but don’t make too many Pull Requests to fix typos in a row, as it causes unnecessary spam. The best alternative is to “bundle” several typo fixes in one PR.
There are no stupid questions — only unanswered ones (and I try to avoid those). If you have any questions, don’t hesitate to ask, as I try to reply to all. You can use the following e-mail: real_mf366@yahoo.com.

If those rules did not scare you away, the GitHub repository is right here. Thanks ahead for your contributions.

2. What is TSpE?

For its entirety, this documentation assumes the user knows: what Supaplex is and how to, later on, “use” the levels in software such as Megaplex, or just Supaplex Online. It’s highly recommended to have a certain degree of experience around the terminal.

Terminal Supaplex Editor - or TSpE for short - is one of the most recent Supaplex level editors to have the terminal as the main “target”.

Fully made in Python, it is capable of handling basic Supaplex level format (no Megaplex support yet) and is bundled with tons of useful features, one of which is the ability to test the level that’s being edited with Supaplex Online, the main platform for uploading levels and playing other people’s ones.

While it’s sadly not very extensible, its easy-to-understand settings.json, the main file you’ll be using - as a user - to enhance your experience.

Without further ado, let’s jump into the second topic: How to install TSpE.

2.1. Licensing (TSpE)

TSpE itself is licensed under the GNU General Public License (GPL v3.0). All forks, modifications and whatnot of the program must comply with GPL’s terms and conditions.

3. How to install TSpE

Lorem ipsum…