Repository navigation
Docs
You can download the source code by going to Code -> Download ZIP. After downloading, extract all the files somewhere. Note: This does not include the Java Runtime Environment. You can get it seperately, or get Processing. Processing is a free, open-source software that allows you to make graphical things easily. ConsoleEmulator was written using Processing. To get it, head to the official website. After that, open the .pde file using it. This will allow you to edit the source code as well.
Head to releases and scroll down a bit, until you see the Assets tab. Then, download whatever .zip matches the operating system you are using (sorry, Mac users!). Extract it, and then open the executable inside. You can edit files in the /data folder as well.
ConsoleEmulator uses JSON files for configuration. These files can be found in the data folder. core.json is a critical file, and cannot be renamed/deleted. messages.json contains the messages you want displayed, and some data. terminal.gff has data in the GFF format, which is used to draw the terminal graphic. messages.json and terminal.gff can be renamed, however you need to update their names in core.json!
The main configuration file. This file cannot be renamed. Inside core.json, there are several tags that you can configure.
| Name | Type | Default | Description |
|---|---|---|---|
version |
String | "Console Emulator 0.1.0 alpha" |
Version text |
messageFont |
String | "defaultFont3.ttf" |
Name of font used for messages |
editorFont |
String | "defaultFont4" |
Name of font used for the UI |
creditText |
String | "A DIY Labs Production" |
Text displayed next to the version |
fontConversionSize |
Int | 100 |
What size to convert the font at |
gffFile |
String | "terminal.gff" |
GFF file for drawing the terminal |
messageFile |
String | "messages.json" |
JSON file containing messages |
defaultTextR |
Int | 255 |
Red component of the default text color |
defaultTextG |
Int | 176 |
Green component of the default text color |
defaultTextB |
Int | 0 |
Blue component of the default text color |
terminalWidth |
Int | 400 |
Unused |
terminalHeight |
Int | 500 |
Unused |
startX |
Int | 500 |
X coordinate of top-left corner of textbox |
startY |
Int | 500 |
Y coordinate of top-left corner of textbox |
There are four fonts bundled with ConsoleEmulator, called defaultFont though defaultFont4. If you want to use a custom font, copy the .ttf font file into your /data folder. It is recommended to rename that file, to make it easier to work with.
If you choose to rename/use a different messages.json/terminal.gff, you have to rename them in here as well! Pro tip: After entering the emulation, you can press TAB to reload configs. This is useful if you want to make changes and see them in real time.
This file is where the messages that you want displayed are stored. Each message has six tags that you need to configure:
| Name | Type | Description |
|---|---|---|
message |
String | This is what will be displayed on screen |
r |
Int | Red component of the text |
g |
Int | Green component of the text |
b |
Int | Blue component of the text |
size |
Int | The height of the text, in pixels |
delayBetweenChars |
Int | How many milliseconds to wait before printing each character |
This is one "message". For multiple messages, add a comma between the {}. Note: There should be [] at the start and end of this file. If you don't want to worry about it, just copy the default file's contents, and only change the parameters you need. Messages are loaded in the order they are in the config file, going from top to bottom. If you want a delay between two messages, you can add spaces to the end of a message.
This is the file that ConsoleEmulator uses to draw the terminal graphic. Read GFF's documentation to understand how it works.
Honestly, ¯\_(ツ)_/¯