Skip to content

Commit 9f5fe5b

Browse files
committed
foxed on-site navigation
1 parent 592f7cc commit 9f5fe5b

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,15 +101,15 @@ That doesn't prevent any commercial use, but you need to respect the terms and c
101101

102102
We would appreciate contributions to PPUC itself or as game-specific PPUs.
103103

104-
# ZeDMD
104+
## ZeDMD
105105

106106
ZeDMD is a "real" DMD for pinball emulations and other use cases, developed as part of the PPUC project.
107107
For more details, visit the [ZeDMD page](https://github.com/PPUC/ZeDMD).
108108

109109
[![Watch the video](https://img.youtube.com/vi/B6D00oB4Co8/hqdefault.jpg)](https://youtu.be/B6D00oB4Co8)
110110
*Click the image to watch the video on YouTube.*
111111

112-
# Other components of the PPUC project
112+
## Other components of the PPUC project
113113

114114
To reach our goals, we contribute to other projects like VPX Standalone, batocera, libdmdutil, libserum etc.
115115
Some libraries and sub-projects that are also leveraged by others are hosted as PPUC projects:

docs/ppuc/config_tool.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11

22
# Config Tool
33

4-
# Function
4+
## Function
55

66
The [Config Tool](https://github.com/PPUC/config-tool) is needed to appropriately map the IO-Board inputs and outputs to a ROM in PinMame. The numbers of the inputs and outputs from PinMame are assigned to the inputs and outputs of the IO-Board firmware in the config file. In PinMame, original pinball ROM circuits are emulated. PPUC-Pinmame outputs the events of the circuit and accepts inputs for the emulated ROM. Without a config file, PPUC-Pinmame cannot communicate with the boards.
77

8-
# Config File
8+
## Config File
99

1010
The Config Tool outputs a config file as a result. This file has the extension ".yml". The goal of your work, besides collecting pinball data, is primarily the generation of this file.
1111

1212
The YAML format used is very common for configuration files as it is a quasi-standard and easily readable by humans. In YAML, indentation determines which elements belong together and form a group. It is advisable not to edit this file manually, because a line break, a separator, or a space can easily be deleted, moved, or added, making the file unreadable. **Caution! Do not modify the file manually.**
1313

14-
# Components of a Configuration
14+
## Components of a Configuration
1515

1616
A configuration file for PPUC-PinMame consists of the following element groups:
1717

@@ -37,9 +37,9 @@ These are the important elements needed for the connection between Pinmame and I
3737
- Switch Position Plan
3838
- Solenoid Position Plan
3939

40-
# First Steps
40+
## First Steps
4141

42-
## Important before we begin
42+
### Important before we begin
4343

4444
Pinball machines usually have protective functions. Sometimes they are real switches, sometimes switching states in the machine's circuit. If you're building a playfield from scratch, or just want to try out part of the pinball machine, PinMame might not work as expected because you haven't created these states. Conditions are:
4545

@@ -48,13 +48,13 @@ Pinball machines usually have protective functions. Sometimes they are real swit
4848

4949
PinMame uses the inputs of the original ROMs. Therefore, they are manufacturer-specific. E.g., Game On Solenoid: Williams System 3 - 11: 23 Williams WPC: 31 Data East: 23 Sega: 15 Gottlieb System 1: 17 Gottlieb System 80: 10 Gottlieb System 3: 32 **Note:** Also think about other switches that must be closed before a game starts. For example, whether a ball is in the ball trough. Possibly also whether enough balls are in the ball trough (switch at the last ball).
5050

51-
## Installation and Launch of the Config Tool
51+
### Installation and Launch of the Config Tool
5252

5353
Installation instructions
5454

5555
..
5656

57-
# Interface
57+
## Interface
5858

5959
### Home
6060

@@ -104,7 +104,7 @@ PPUC-Config Tool will make different versions of the game available in the futur
104104

105105
Elements such as Boards, LED-Strings, LEDs, etc. can be cloned using this button. This means that the element is cloned with the last saved inputs. You can recognize this by the extended title "Clone".
106106

107-
# Creating a Game
107+
## Creating a Game
108108

109109
![enter image description here](/docs/images/config_tool/AddGame.png)
110110

@@ -262,26 +262,26 @@ Warning: simply copying these examples can damage the hardware!
262262
**Drop Target Up:**
263263
**Outhole:**
264264

265-
# View
265+
## View
266266
Here you'll always have an overview of all elements added to the game. You can also edit them directly by clicking Edit.
267267

268268
![enter image description here](/docs/images/config_tool/view.png)
269269

270270

271-
# Config File Export
271+
## Config File Export
272272

273273
![enter image description here](/docs/images/config_tool/mainmenudownloadconfig.png)
274274

275275
This button in the side header of a selected game saves the complete information that has been added to the game. The file name is generated from the Game Title. The file is written in plain text in YAML format. You use this file with PPUC-Pinmame. With this, the PPUC part in PinMame learns the structure of the board configuration. You can create different configurations and use them in PPUC-Pinmame.
276276

277-
# Save Configuration Completely
277+
## Save Configuration Completely
278278

279279
![enter image description here](/docs/images/config_tool/mainmenuexport.png)
280280

281281
This button in the side header of a selected game saves the complete information that has been added to the game. The file name is strangely long, but this makes it unique and machine-readable. You should regularly create a backup using this button. After triggering the button, the file is immediately saved to the browser's download folder. This file can be loaded later (Game Import) or passed on. The file is not saved in plain text and includes ROM and image files.
282282

283283

284-
# Troubleshooting
284+
## Troubleshooting
285285

286286
If you encounter issues with your configuration, here are some common problems and solutions:
287287

0 commit comments

Comments
 (0)