You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ppuc/config_tool.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
1
1
2
2
# Config Tool
3
3
4
-
# Function
4
+
##Function
5
5
6
6
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.
7
7
8
-
# Config File
8
+
##Config File
9
9
10
10
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.
11
11
12
12
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.**
13
13
14
-
# Components of a Configuration
14
+
##Components of a Configuration
15
15
16
16
A configuration file for PPUC-PinMame consists of the following element groups:
17
17
@@ -37,9 +37,9 @@ These are the important elements needed for the connection between Pinmame and I
37
37
- Switch Position Plan
38
38
- Solenoid Position Plan
39
39
40
-
# First Steps
40
+
##First Steps
41
41
42
-
## Important before we begin
42
+
###Important before we begin
43
43
44
44
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:
45
45
@@ -48,13 +48,13 @@ Pinball machines usually have protective functions. Sometimes they are real swit
48
48
49
49
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).
50
50
51
-
## Installation and Launch of the Config Tool
51
+
###Installation and Launch of the Config Tool
52
52
53
53
Installation instructions
54
54
55
55
..
56
56
57
-
# Interface
57
+
##Interface
58
58
59
59
### Home
60
60
@@ -104,7 +104,7 @@ PPUC-Config Tool will make different versions of the game available in the futur
104
104
105
105
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".
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.
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.
282
282
283
283
284
-
# Troubleshooting
284
+
##Troubleshooting
285
285
286
286
If you encounter issues with your configuration, here are some common problems and solutions:
0 commit comments