PTC Interpreter, attempt two!
The original PTC software was created by SmileBoom. This software requires you to have a legal copy of the original PTC for full function. Please do not use the program with unlicensed copies.
This project is an attempt at recreating the mechanics of Petit Computer, to be able to run PTC programs on PC. The end goal is to support all commands and functions that are usable from programs. Accuracy will likely not be 100%, though most programs should run as expected. Note that bugs will probably not be recreated, so stuff like -0 or the COLSET bug/crash will not work the same.
Please note that this is a WIP, so don't be surprised if something breaks. If it does, please create an issue describing the problem, and either provide the crashing/broken program or an example that demonstrates the problem.
The current project has some amount of support for SAMPLE1-SAMPLE12, and GAME1-GAME5. See https://github.com/Minxrod/PTC-EmkII/projects/1 or https://github.com/Minxrod/PTC-EmkII/projects/2 for more info.
Place your PTC .nds file in the resources/ directory, then from a terminal/console run
cd resources/
./nds_extract <ptc_file>.nds
cd resources/
nds_extract.bat <ptc_file>.nds
This should automatically extract all required graphics and sound resources to the correct locations.
If the precompiled versions of ndstool or sdatxtract do not work, see the Tools link below and compile/download the binaries yourself, and replace the copies in resources/tools/.
Put any PTC files you want to run or load in the programs/ folder. This includes resources, such as CHR or GRP files. You will be prompted to enter a filename when launching PTC-EmkII.
Buttons:
- WASD = dpad
- Arrow Keys = ABXY
- Q = L
- E = R
- Enter = Start
- RShift = Select
Special keys:
- F1: Zoom x1
- F2: Zoom x2
- F5: Restart current program (Note: Will wait until end of current instruction to take effect, will not work if program has already terminated)
- F10: Disable/Enable keyboard buttons
- F11: Disable/Enable keyboard
- F12: Open debugger window
KEYBOARD and INKEY$() are approximated by typing on the keyboard, and most characters should be typed as expected. Holding Alt should allow you to type codes in the upper half of the range. If you have a japanese keyboard layout/can type katakana, this should also work.
The touch keyboard is mostly functional, though some keys still have no effect.
- -s Disable sound system entirely. This also disables BGMCHK and the like, so this is not recommended if your program needs this.
- -d Opens a debugger window immediately after starting.
- -a Enable automatic restart on program end. When a PTC program ends, this will restart the currently loaded program.
- -p Load program from a file path. This skips the default 'loader' program.
The debugger is a second window that can be opened on execution with the -d option, or opened with F12 while running programs. Currently, lets you track simple variables, set breakpoints, and view CHR resource textures.
Currently, the options are as follows:
tr expression- Add an expression to the listrm expression- Remove an expression from the listexit- Close the debugger windowbr line- Sets a breakpoint at lineclear line- Removes a breakpoint at linec- Continue if program execution is paused from a breakpointtex index [palette]- Displays the resource corresponding to the given index.
Note that expressions are updated per-frame, not as values change. Also, note that functions, operations and variable access will work in these expressions, but that attempting to create a new variable is not currently supported and will likely crash due to thread-safety issues.
Requirements:
- SFML 2.5.1
- g++ supporting c++17 (c++1z may work as well, with some effort)
- make or something compatible
- Python 3 (for extraction scripts, technically optional if you manually perform the extraction)
Clone this repo, then create a build directory named "build/" in the root of the repo. Ensure you have SFML installed, and run make. It should work (currently untested on other machines). If you don't have SFML installed, go here first: https://www.sfml-dev.org/tutorials/2.5/start-linux.php
Commands will probably look something like this:
git clone https://github.com/Minxrod/PTC-EmkII.git
cd PTC-EmkII
mkdir build/
make
Instructions should be roughly the same as linux, but may require some modifications to the makefile. It is expected you have git installed and accessible from the command line. It is suggested you use the version with MinGW 7.3.0 32-bit linked from https://www.sfml-dev.org/download/sfml/2.5.1/, as it is known to work. (Add the mingw/bin folder within MinGW to your path for best results.)
If you install SFML to a location other than C:/SFML-2.5.1/, modify the SFML_PATH variable in the makefile to reflect this.
Then, the instructions should be similar to
git clone https://github.com/Minxrod/PTC-EmkII.git
cd PTC-EmkII
mkdir build/
mingw32-make
Additionally, you will need to move the relevant .dll files to the project root. You can find these in your SFML installation, in the bin folder. If you used the suggested installation folder, you can use the following commands:
cp C:\SFML-2.5.1\bin\* .
cp lib\SSEQPlayer.dll .
To build the documentation, install doxygen and use
doxygen doxyconfig
Note that this is primarily documentation for the source code.
Licenses for these are located in resources/tools/ along with the binaries.
- https://create.stephan-brumme.com/hash-library/ (under zlib license)
- www.sfml-dev.org (under zlib license)
- https://github.com/catchorg/Catch2 (boost software license 1.0)
- https://en.cppreference.com
- www.sfml-dev.org
- https://stackoverflow.com
- https://petitcomputer.fandom.com/wiki/Petit_Computer_Wiki
- https://micutil.com/ptcutilities/top_e.html
- Whatever is linked in the source
- And probably more that has been forgotten.