Skip to content

Commit 84cb0d6

Browse files
authored
Update readme
1 parent 2c7411e commit 84cb0d6

File tree

1 file changed

+52
-6
lines changed

1 file changed

+52
-6
lines changed

README.md

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,72 @@
1+
12
# Arcade Database for MiSTer
23

4+
5+
36
The ArcadeDatabase_[MiSTer](https://github.com/MiSTer-devel/Wiki_MiSTer/wiki) repo contains files and lists about the different arcade core MRAs that are available for MiSTer.
47

5-
Anything missing in the database or have a suggestion? Create an issue ticket or submit a pull request.
8+
9+
10+
# How to contribute
11+
12+
To make it easier for users to contribute, we now have automation.
13+
14+
If you want to add or update entries in the database, follow these simple steps:
15+
16+
17+
18+
1. Download the current CSV file from the repository.
19+
20+
21+
22+
2. Edit it locally with your changes (you can import it to excel if you want to, just note the delimiter we use is comma).
23+
24+
25+
26+
3. Upload your modified CSV file to the ArcadeDatabase_CSV folder and make a pull request.
27+
28+
29+
30+
4. Once your CSV file is uploaded and the pull request is merged, the automation script will process it and update the database accordingly.
31+
32+
633

734
# Naming convention
8-
Since it is important to know exactly what version of the game you play, I've decided to go for the following naming convention:
9-
Game Name (Country, Version) [bl/hb].
10-
Country should follow the [Alpha-2](https://www.iban.com/country-codes) country code.
11-
[bl] means Bootleg
35+
36+
Since it is important to know exactly what version of the game you play, I've decided to go for the following naming convention:
37+
38+
Game Name (Country, Version) [bl/hb].
39+
40+
Country should follow the [Alpha-2](https://www.iban.com/country-codes) country code.
41+
42+
[bl] means Bootleg
43+
1244
[hb] means Homebrew
1345

46+
47+
1448
# Preferred version
49+
1550
As you might've noticed, there are different versions/clones of the same game. Sometimes the preferred version is documented, and sometimes it is not. Basic rule of thumb is the following (from MAME doc):
1651

52+
53+
1754
```
55+
1856
- Prefer latest release version
57+
1958
- Prefer English language
59+
2060
- Prefer most widespread release
61+
2162
- Prefer most complete version
63+
2264
- Prefer versions that are uncensored, and have story/cutscenes intact
65+
2366
- Prefer versions that keep the original gameplay balance
67+
2468
- Prefer releases from original developers/publishers rather than licensees
69+
2570
- Prefer releases without region-specific notices or warnings
26-
```
71+
72+
```

0 commit comments

Comments
 (0)