Skip to content

Commit 10ee598

Browse files
author
sourcehold
committed
docs: clarify aim and approach
1 parent 5479a41 commit 10ee598

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

docs/about.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ and accessible to everyone.
99

1010
Aims
1111
====
12+
.. _About_Aims:
1213

1314
The two main aims are:
1415

@@ -33,3 +34,4 @@ While the reimplementation is underway, Windows DLL files are released that prov
3334

3435
For example, API functions are added to provide modding access to reimplemented parts.
3536

37+
.. include:: wiki-approach.rst

docs/wiki-approach.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
Approach
22
===========
33

4+
This project's approach fulfills two aims as outlined in :ref:`Aims <About_Aims>`. Below a few examples are given to illustrate the approach.
5+
6+
Essentially, the approach recreates source code for the original game, and in the meantime adds macro's to support mods.
7+
8+
Two criteria define succesful code:
9+
10+
#. Faithful to the original. Byte-code similarity can be tested using the `reccmp` framework. A higher similarity indicates better code, but 100% similarity isn't a requirement, as incremental improvements are also great.
11+
#. Modding abilities. The new source code should include toggles to toggle moddability on or off. If off, the code should function as identically as feasible compared to the original game. If on, mods can alter the functionality of the code.
12+
13+
Note that mods itself are outside the scope of this project. This project is meant to facilitate mods, not implement them.
14+
415
Examples
516
--------
617

0 commit comments

Comments
 (0)