Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== RPGText ======
RPG Text is a framework to develop Text-Based RPG games
The main idea is to abstract the engine and needed base code so the developer can focus on creating the history

==== Usage ====
Since RPGText is a Library it can be used directly in a C program or you can use the toolchain.

=== Before Using ===
Before using the library you'll need to 
build it 

To do it you'll need to do the following:

<code bash>
TBA
</code>
=== Using on a C Program ===
This method is in a way a short circuit to the result generated if you used the tool chain.
This method is not recommended but will work and is recommended if you are an experienced programmer.

Here is the steps:
<code c++>
TBA
</code> 

=== Using the toolchain ===
This method make use of a custom language to make the programming simple and a tool chain that will transpile (transform) the code in the custom  language to C++ and make the executable of the game

== Tools ==
The tools in the tool chain consists in a cli too that manages the project and also do the transpiling and compiling to an executable.

The tools is better explained in [[rpgtext_toolchain|RPGText Toolchain]]