Echo Hollow

Because Pr0n is the Highest Form of Art.

User Tools

Site Tools


libecho:classes:start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
libecho:classes:start [2023/01/13 16:41] leelibecho:classes:start [2023/08/06 19:23] (current) – removed lee
Line 1: Line 1:
-====== LibEcho Class Reference ====== 
- 
-I was originally doing this automagically with JSDoc, but it made the source code a mess.  So here it all is redone by hand in markdown. 
- 
-I do my best to keep this up-to-date, but the [[http://svn.echohollow.net/libecho/|source code]] is the ultimate reference. 
- 
-This file is meant to be dry technical documentation of the class implementation for reference purposes.  For a more friendly treatise on using the library, please see the [[LibEcho:Tutorial:|Tutorial]]. 
- 
-===== Namespaces ===== 
- 
-The class hierarchy is divided into a number of namespaces, documented separately: 
-  * [[libecho:classes:apparel|LibEcho.Apparel]] 
-  * [[libecho:classes:grammar|LibEcho.Grammar]] 
-  * [[libecho:classes:inventory|LibEcho.Inventory]] 
-  * [[libecho:classes:people|LibEcho.People]] 
-  * [[libecho:classes:persistence|LibEcho.Persistence]] 
-  * [[libecho:classes:transformable|LibEcho.Transformable]] 
-  * [[libecho:classes:util|LibEcho.Util]] 
- 
- 
-===== Building from source ===== 
- 
-==== Eclipse ==== 
-  - Be running some kind of Unix-like OS with Bash installed (the build scripts use bash). 
-  - Install node-js (used for compiling the classes). 
-  - Create a "Tweego" project in your workspace and install the Tweego binary and story-formats into it. 
-  - Check out the project from SVN. 
-  - Watch it build automatically. 
- 
-==== Commandline ==== 
-  - Be running some kind of Unix-like OS with Bash installed (the build scripts use bash). 
-  - Install node-js (used for compiling the classes). 
-  - cd build && npm install 
-  - You now have all the dependencies installed. 
-  - Whenever you want to (re)build the library: cd build && ./build.sh 
- 
-==== Non-Unix Platforms ==== 
-If you want to write a build script for Windows or whatever, feel free to send it to me and I'll include it in the repo.