Skip to content

Commit 7fa817b

Browse files
committed
fixed docroot
1 parent df57504 commit 7fa817b

File tree

2 files changed

+59
-62
lines changed

2 files changed

+59
-62
lines changed

docs/ppuc/config_tool.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -58,83 +58,83 @@ Installation instructions
5858

5959
### Home
6060

61-
![Config-Tool GUI Home](/images/config_tool/GUI-Home.png)
61+
![Config-Tool GUI Home](/docs/images/config_tool/GUI-Home.png)
6262

63-
![Config-Tool GUI Home - Games](/images/config_tool/GUI-Home_001.png)
63+
![Config-Tool GUI Home - Games](/docs/images/config_tool/GUI-Home_001.png)
6464

6565
### View
6666

67-
![enter image description here](/images/config_tool/mainmenuview.png)
67+
![enter image description here](/docs/images/config_tool/mainmenuview.png)
6868

6969
Summary of the Game elements.
7070

7171
### Edit
7272

73-
![enter image description here](/images/config_tool/mainmenuedit.png)
73+
![enter image description here](/docs/images/config_tool/mainmenuedit.png)
7474

7575
Edit the inputs that were requested when creating the game. (Title, Description, Platform, Images, ROM, etc.)
7676

7777
### Export
7878

79-
![enter image description here](/images/config_tool/mainmenuexport.png)
79+
![enter image description here](/docs/images/config_tool/mainmenuexport.png)
8080

8181
**Save directly when clicking on Export.** This saves the game completely. This file can be used to create backup copies of all inputs for the currently opened game. The save is placed in the browser's download folder.
8282

8383
### Download Game Config
8484

85-
![enter image description here](/images/config_tool/mainmenudownloadconfig.png)
85+
![enter image description here](/docs/images/config_tool/mainmenudownloadconfig.png)
8686

8787
**Save directly when clicking on Download Game Config.** This saves the config file for use in PPUC-PinMame. The save is placed in the browser's download folder.
8888

8989
### Delete
9090

91-
![enter image description here](/images/config_tool/mainmenuDelete.png)
91+
![enter image description here](/docs/images/config_tool/mainmenuDelete.png)
9292

9393
**CAUTION:** After confirmation, **the currently opened element** will be irrevocably deleted. The currently opened element (Game, LED-Stripe, LED, PWM-Device, Board, etc.) is deleted via this button. If you are in the game interface without having selected an element, the game will be deleted. **Note when deleting a game:** Only the game configuration is deleted. All associated boards, LED-Stripes, etc. remain. These will still be available for selection in the settings. If you want to delete the elements of a game, it's best to delete the subordinate elements first!
9494

9595
### Revision
9696

97-
![enter image description here](/images/config_tool/mainmenurevision.png)
97+
![enter image description here](/docs/images/config_tool/mainmenurevision.png)
9898

9999
PPUC-Config Tool will make different versions of the game available in the future.
100100

101101
### Clone
102102

103-
![enter image description here](/images/config_tool/mainmenuclone.png)
103+
![enter image description here](/docs/images/config_tool/mainmenuclone.png)
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

107107
# Creating a Game
108108

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

111111
A new game is created by pressing the "+ Add Game" button.
112112

113-
![Config-Tool Create New Game](/images/config_tool/create_new_game_001.png)
113+
![Config-Tool Create New Game](/docs/images/config_tool/create_new_game_001.png)
114114

115115
Now fill in the fields. Required fields are marked with asterisks (*). **Don't forget** that your game may not start if you haven't defined **Game On Solenoid** and **Coin Door Closed Switch**.
116116

117117
Another important feature is the Platform.
118118

119-
![Config-Tool Platform](/images/config_tool/platform.png)
119+
![Config-Tool Platform](/docs/images/config_tool/platform.png)
120120

121121
The manufacturers of pinball machines developed their systems over time and designed different platforms. The characteristics of the platforms are taken into account through the appropriate selection. There is not yet a separate selection for all platforms. DE = DataEast, SYS11 and SYS4
122122

123123
**Save the data** - You will receive confirmation that your game has been created.
124124

125-
![Config-Tool Save](/images/config_tool/save.png)
125+
![Config-Tool Save](/docs/images/config_tool/save.png)
126126

127127
You will automatically switch to the editor interface of the game.
128128

129129
## Adding an IO-Board
130130

131-
![Config-Tool Add-IO-Board](/images/config_tool/AddIOBoard.png)
131+
![Config-Tool Add-IO-Board](/docs/images/config_tool/AddIOBoard.png)
132132

133-
![Config-Tool Create I/O Board](/images/config_tool/AddBoard.png)
133+
![Config-Tool Create I/O Board](/docs/images/config_tool/AddBoard.png)
134134

135135
- **Title:** Choose a unique title that helps you identify the board.
136136
- **Game:** Select the game you created earlier.
137-
- **Number:** Enter the number of the I/O Board that you have set on the DIP switch on the board. The number can be set from 0 to 16. It is the address that tells the board it needs to respond to the data communication. ![Config-Tool DIP Switch Hardware](/images/config_tool/photoDipSwitches.png)
137+
- **Number:** Enter the number of the I/O Board that you have set on the DIP switch on the board. The number can be set from 0 to 16. It is the address that tells the board it needs to respond to the data communication. ![Config-Tool DIP Switch Hardware](/docs/images/config_tool/photoDipSwitches.png)
138138
- **Type:** Also select the board type here.
139139
- **Note:** The board, like other elements, can be assigned to multiple games. This might be important for you later when naming the board to recognize the boards.
140140

@@ -165,7 +165,7 @@ After you have created a game and a board, now add the elements.
165165

166166
## Switch
167167

168-
![Config-Tool Create Switch](/images/config_tool/AddSwitchMenu.png)
168+
![Config-Tool Create Switch](/docs/images/config_tool/AddSwitchMenu.png)
169169

170170
- **Title:** Choose a unique title that helps you identify the board.
171171
- **Number:** This number is received by PinMame from the board and evaluated in the simulated ROM. This means that the number must be the same number that is used in the ROM. You can find this number in the manual of the pinball machine.
@@ -184,20 +184,20 @@ After you have created a game and a board, now add the elements.
184184

185185
This controls WS2811, WS2812, and other addressable LEDs, also RGBW like SK6812. It doesn't have to be a chain. It can also be strips, or individual LEDs that are connected to each other in another way. The principle of these LEDs, however, is to form a continuous chain, in which the data line only goes in one direction and only as one strand, never in a circle. For control, data is sent to the corresponding LED. This data packet passes by all connected LEDs. Only the LED with the corresponding number responds.
186186

187-
![enter image description here](/images/config_tool/AddLEDStringMenu.png)
187+
![enter image description here](/docs/images/config_tool/AddLEDStringMenu.png)
188188
**Title:** Choose a unique title that helps you identify the light chain. **I/O Board:** The I/O board to which the LED chain is connected. **Port:** Port number of the board to which the LED chain is connected. For the I/O Boards 16-8-1, this is port 25. See the labeling on the board:
189-
![enter image description here](/images/config_tool/LED-Connector_low.png)
189+
![enter image description here](/docs/images/config_tool/LED-Connector_low.png)
190190
**LED Type:** Here the color type is specified. Whether RGB, GBR, BRG, RGBW, and so on... The transferred color values are put into the right order with this. **Amount of LEDs:** Number of LEDs in the chain.
191191

192192
### Segments
193193

194-
![enter image description here](/images/config_tool/AddLEDStringSegments.png)
194+
![enter image description here](/docs/images/config_tool/AddLEDStringSegments.png)
195195

196196
The light chain can be divided into segments. This serves to apply animated light effects to certain sections of the chain. These effects are predefined and stored in the firmware of the boards and can be triggered. **From** - **to** defines the position of the first and last LED of the respective section in the chain.
197197

198198
### Light
199199

200-
![enter image description here](/images/config_tool/AddLEDStringLight.png)
200+
![enter image description here](/docs/images/config_tool/AddLEDStringLight.png)
201201

202202
- **After Glow (Milliseconds):** The brightness of the LED is faded out and not switched off abruptly. This simulates the behavior of the incandescent lamps of the old devices.
203203
- **Light Up (Milliseconds):** The brightness of the LED is faded in and not switched on abruptly. This simulates the behavior of the incandescent lamps of the old devices.
@@ -207,7 +207,7 @@ The light chain can be divided into segments. This serves to apply animated ligh
207207

208208
Add LEDs to your LED chain. You can create each LED individually, or use the Clone function to adopt parameters.
209209

210-
![enter image description here](/images/config_tool/AddAdressableLed.png)
210+
![enter image description here](/docs/images/config_tool/AddAdressableLed.png)
211211

212212
- **Title:** Choose a unique title that helps you identify the lamp.
213213
- **Role:** Here you select the type of imitated lamp of the pinball machine. There are Lamp, Flasher (5V), GI. See the description of the lamp types a bit further down.
@@ -234,16 +234,16 @@ PWM Device refers to the electromagnets or other pinball hardware (usually insta
234234

235235
Pulse Width Modulation (PWM) is a technique where the output voltage is regulated by rapidly switching the current flow on and off and varying the on-time (pulse width). A longer on-pulse results in a higher average output voltage, while a shorter pulse creates a lower voltage. This method allows efficient and precise control of power output. PWM is also used to keep the output voltage stable, even if the load changes. In addition, it allows the control of LED brightness, motor speed, and power output to many other electronic devices.
236236

237-
![enter image description here](/images/config_tool/AddPWMmenu1.png)
237+
![enter image description here](/docs/images/config_tool/AddPWMmenu1.png)
238238

239239
- **Title:** Choose a unique title that helps you identify the PWM-Device.
240240
- **Type:** Since there are different types of controllable hardware with higher voltage, select the corresponding type here.
241241
- **Number:** This number is received by the board from PinMame from the simulated ROM. This means that the number must be the same number that is also used in the ROM to control this hardware. You can find this number in the manual of the pinball machine.
242242
- **I/O Board:** The I/O board to which the LED chain is connected.
243-
- **Port:** The number of the output to which the hardware to be addressed is connected. Example I/O-Board 16-1-1: ![enter image description here](/images/config_tool/PWM-Connector_low.png)
243+
- **Port:** The number of the output to which the hardware to be addressed is connected. Example I/O-Board 16-1-1: ![enter image description here](/docs/images/config_tool/PWM-Connector_low.png)
244244

245245

246-
![enter image description here](/images/config_tool/AddPWMmenu2.png)
246+
![enter image description here](/docs/images/config_tool/AddPWMmenu2.png)
247247

248248
- **Power (0-255):** 0 = 0 Volt. 255 = full power supply performance (pay attention to the max allowed voltage). Values between 0 and 255 reduce the power supply voltage.
249249
- **Note:** The power supply voltage does not reduce linearly! You must measure the voltage corresponding to the value before using it.
@@ -265,18 +265,18 @@ Warning: simply copying these examples can damage the hardware!
265265
# 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

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

270270

271271
# Config File Export
272272

273-
![enter image description here](/images/config_tool/mainmenudownloadconfig.png)
273+
![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

277277
# Save Configuration Completely
278278

279-
![enter image description here](/images/config_tool/mainmenuexport.png)
279+
![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

mkdocs.yml

Lines changed: 31 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,59 @@
11
site_name: Pinball Power-Up Controller & DMD
2-
site_url: https://ppuc.org/
3-
site_description: Pinball Poewer-Up Controller & DMD (PPUC) is a free and open-source pinball controller and display system.
2+
site_url: https://ppuc.github.io/docs/
3+
site_description: Pinball Power-Up Controller & DMD (PPUC) is a free and open-source pinball controller and display system.
44
use_directory_urls: true
55
repo_url: https://github.com/PPUC/docs
66
repo_name: Website source on GitHub
77
edit_uri: blob/main/docs/
8+
docs_dir: docs
89

910
plugins:
10-
- search # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
11+
- search
1112
extra_css:
12-
- stylesheets/ppuc.css # Sets our custom colors
13+
- stylesheets/ppuc.css
1314

1415
markdown_extensions:
15-
- toc: # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents
16+
- toc:
1617
title: On this page
17-
- attr_list # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists
18-
- tables # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/s#tables
19-
- admonition # https://squidfunk.github.io/mkdocs-material/reference/admonitions/
20-
- pymdownx.details # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details
21-
- pymdownx.superfences # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences
22-
- pymdownx.emoji: # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
18+
- attr_list
19+
- tables
20+
- admonition
21+
- pymdownx.details
22+
- pymdownx.superfences
23+
- pymdownx.emoji:
2324
emoji_index: !!python/name:material.extensions.emoji.twemoji
2425
emoji_generator: !!python/name:material.extensions.emoji.to_svg
25-
- pymdownx.snippets: # https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
26+
- pymdownx.snippets:
2627
base_path: includes
2728
check_paths: true
2829
auto_append:
2930
- content_footer.md
30-
- pymdownx.keys # https://facelessuser.github.io/pymdown-extensions/extensions/keys/
31+
- pymdownx.keys
3132

3233
theme:
33-
name: material # https://squidfunk.github.io
34-
logo: images/logo.png
34+
name: material
35+
logo: /docs/images/logo.png
3536
icon:
36-
# logo: material/checkbox-blank-circle
3737
repo: fontawesome/brands/github
3838
edit: fontawesome/solid/wand-magic-sparkles
39-
custom_dir: overrides # https://squidfunk.github.io/mkdocs-material/customization/#extending-the-theme
39+
custom_dir: overrides
4040

4141
features:
42-
- navigation.instant # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading
43-
- navigation.footer # https://squidfunk.github.io/mkdocs-material/upgrade/#navigationfooter
44-
- navigation.tabs # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs
45-
- navigation.indexes # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
46-
- navigation.top # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button
47-
- content.action.edit # https://squidfunk.github.io/mkdocs-material/upgrade/#contentaction
48-
- toc.follow # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-following
49-
- content.code.annotate # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations
42+
- navigation.instant
43+
- navigation.footer
44+
- navigation.tabs
45+
- navigation.indexes
46+
- navigation.top
47+
- content.action.edit
48+
- toc.follow
49+
- content.code.annotate
5050

51-
palette: # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#color-palette-toggle
52-
# Palette toggle for light mode
53-
- scheme: default # specified in docs/stylesheets/ppuc.css
51+
palette:
52+
- scheme: default
5453
toggle:
5554
icon: material/brightness-7
5655
name: Switch to dark mode
57-
58-
# Palette toggle for dark mode
59-
- scheme: slate # specified in docs/stylesheets/ppuc.css
56+
- scheme: slate
6057
toggle:
6158
icon: material/brightness-4
6259
name: Switch to light mode
@@ -65,17 +62,17 @@ theme:
6562
code: Noto Sans Mono
6663

6764
extra:
68-
social: # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/?h=social#social-links
65+
social:
6966
- icon: fontawesome/brands/github
7067
link: https://github.com/PPUC
7168
- icon: fontawesome/brands/discord
7269
link: https://discord.gg/fkkk4MbBn5
7370
name: Join our Discord
71+
base_url: /docs/
7472

7573
nav:
7674
- PPUC:
7775
- ppuc/index.md
7876
- ppuc/config_tool.md
79-
8077
- ZeDMD:
81-
- zedmd/index.md
78+
- zedmd/index.md

0 commit comments

Comments
 (0)