Finished the Contributing Guide, and wrote a readme.
This commit is contained in:
parent
50cc112fa2
commit
fbe10ec720
|
@ -1,5 +1,7 @@
|
||||||
# Contributing
|
# Contributing
|
||||||
Contributions to the Citra Games Wiki are welcomed, as keeping all of the data up to date and accurate is a community effort.
|
Contributions to the Citra Games Wiki are welcomed, as keeping all of the data up to date and accurate is a community effort. There are 2 parts to the Wiki:
|
||||||
|
- [Code](#code)
|
||||||
|
- [Wiki](#wiki)
|
||||||
|
|
||||||
Throughout this guide, code blocks like `<Value>` are used. This means that "Value" should be replaced by something, and the "<>" should be deleted.
|
Throughout this guide, code blocks like `<Value>` are used. This means that "Value" should be replaced by something, and the "<>" should be deleted.
|
||||||
|
|
||||||
|
@ -10,7 +12,9 @@ All dates follow the format `<4-Digit Year>-<2-Digit Month>-<2-Digit Day>`. For
|
||||||
Title IDs can be found near the top of a log when running a game. For example, this is what it looks like for The Legend of Zelda: Ocarina of Time: `[ 0.019882] Loader <Info> core/loader/ncch.cpp:Load:340: Program ID: 0004000000033500`.
|
Title IDs can be found near the top of a log when running a game. For example, this is what it looks like for The Legend of Zelda: Ocarina of Time: `[ 0.019882] Loader <Info> core/loader/ncch.cpp:Load:340: Program ID: 0004000000033500`.
|
||||||
|
|
||||||
## Code
|
## Code
|
||||||
The code consists of the actual files in the Github repisitory. At the root, there's a folder for each game. The names of these folders should:
|
The code consists of the actual files in the Github repisitory. To modify them, you have to fork this repo, make your changes, and send a pull request.
|
||||||
|
|
||||||
|
At the root, there's a folder for each game. The names of these folders should follow these specifications:
|
||||||
- Only use letters, numbers, and hyphens (No spaces!), because they will be linked to on the site.
|
- Only use letters, numbers, and hyphens (No spaces!), because they will be linked to on the site.
|
||||||
- Use proper capitalization, for consistency.
|
- Use proper capitalization, for consistency.
|
||||||
- Have a wiki page with the same name.
|
- Have a wiki page with the same name.
|
||||||
|
@ -37,6 +41,23 @@ The metadata for the game is located at `/<Game Name>/game.dat`. This is require
|
||||||
- `USA`
|
- `USA`
|
||||||
- `release_date` (String): When the game was released in this region.
|
- `release_date` (String): When the game was released in this region.
|
||||||
|
|
||||||
|
An example of a game metadata file is the one for [The Legend of Zelda: Ocarina of Time](https://github.com/citra-emu/citra-games-wiki/blob/master/Legend-of-Zelda-Ocarina-of-Time/game.dat):
|
||||||
|
```js
|
||||||
|
title = "The Legend of Zelda: Ocarina of Time 3D"
|
||||||
|
description = "The Legend of Zelda: Ocarina of Time 3D is an action-adventure video game co-developed by Grezzo and Nintendo EAD Tokyo and published by Nintendo for the Nintendo 3DS handheld game console. The game was released worldwide in June 2011."
|
||||||
|
compatibility = 5
|
||||||
|
tested_date = "2017-06-03"
|
||||||
|
tested_version = "HEAD-a7ddec8"
|
||||||
|
needs_system_files = false
|
||||||
|
needs_shared_font = false
|
||||||
|
tested_by = "Flamboyant_Ham"
|
||||||
|
|
||||||
|
[[ releases ]]
|
||||||
|
title = "0004000000033500"
|
||||||
|
region = "USA"
|
||||||
|
release_date = "2011-06-19"
|
||||||
|
```
|
||||||
|
|
||||||
### Icon
|
### Icon
|
||||||
The icon for a game is located at `/<Game Name>/boxart.png`. The suggested process for getting one is:
|
The icon for a game is located at `/<Game Name>/boxart.png`. The suggested process for getting one is:
|
||||||
- Make sure the ROM for the game is in your Citra game directory.
|
- Make sure the ROM for the game is in your Citra game directory.
|
||||||
|
@ -69,7 +90,7 @@ The metadata for a save is located at `/<Game Name>/savefiles/<Save Name>.dat`.
|
||||||
- `title_id` (String): Title ID of the game.
|
- `title_id` (String): Title ID of the game.
|
||||||
|
|
||||||
#### Save Data
|
#### Save Data
|
||||||
The save data is located at `/<Game Name>/savefiles/<Save Name>.csav`. To make a CSAV file, the process is:
|
The save data is located at `/<Game Name>/savefiles/<Save Name>.zip`. To make a ZIP file, the process is:
|
||||||
- Make sure the ROM for the game is in your Citra game directory.
|
- Make sure the ROM for the game is in your Citra game directory.
|
||||||
- Right click on the game and click `Open Save Data Location`. This should open a folder named `data`.
|
- Right click on the game and click `Open Save Data Location`. This should open a folder named `data`.
|
||||||
- Note the folder that the `data` folder is in. This is the low Title ID. As an example, the low Title ID for The Legend of Zelda: Ocarina of Time is `00033500`.
|
- Note the folder that the `data` folder is in. This is the low Title ID. As an example, the low Title ID for The Legend of Zelda: Ocarina of Time is `00033500`.
|
||||||
|
@ -77,4 +98,32 @@ The save data is located at `/<Game Name>/savefiles/<Save Name>.csav`. To make a
|
||||||
- Copy the high title ID folder elsewhere.
|
- Copy the high title ID folder elsewhere.
|
||||||
- Delete everything from the high title ID folder except for the low Title ID folder.
|
- Delete everything from the high title ID folder except for the low Title ID folder.
|
||||||
- Compress the high title ID folder into a ZIP.
|
- Compress the high title ID folder into a ZIP.
|
||||||
- Rename the ZIP file into a CSAV file.
|
|
||||||
|
## Wiki
|
||||||
|
The wiki contains info about specific game problems, and can be modified by anyone. They use [Markdown](https://guides.github.com/features/mastering-markdown/) formatting.
|
||||||
|
|
||||||
|
Each page's title should match the game's respective folder in the code section, except with hyphens in the code changed to spaces on the wiki.
|
||||||
|
|
||||||
|
The format of each page is as follows:
|
||||||
|
- H2 header with text saying `Summary`.
|
||||||
|
- Brief summary of how the game performs.
|
||||||
|
- H3 subheader saying `Problems`.
|
||||||
|
- For each problem, a bullet describing an issue the game has.
|
||||||
|
- For each of those bullets, make a sub-bullet linking to the relevant Github issue on `citra-emu`.
|
||||||
|
- If there's any relevant media, make another sub-bullet linking to it.
|
||||||
|
|
||||||
|
An example of a game wiki page is the one for [Mario Kart 7](https://github.com/citra-emu/citra-games-wiki/wiki/Mario-Kart-7):
|
||||||
|
```markdown
|
||||||
|
## Summary
|
||||||
|
Mario Kart 7 has some problems in Citra. It is playable, but there are minor graphical glitches.
|
||||||
|
|
||||||
|
### Problems
|
||||||
|
- Random crashes may occur.
|
||||||
|
- Github Issue: [#2443](https://github.com/citra-emu/citra/issues/2443).
|
||||||
|
- All particle effects (Such as smoke, tire tracks, or drift sparks.) are rendered incorrectly. They may copy HUD elements, or just be black.
|
||||||
|
- Github Issue: [#1887](https://github.com/citra-emu/citra/issues/1887).
|
||||||
|
- Looping audio buffers aren't supported.
|
||||||
|
- Github Issue: [#2093](https://github.com/citra-emu/citra/issues/2093).
|
||||||
|
- When using the software renderer, Mii characters are not rendered.
|
||||||
|
- Github Issue: [#1749](https://github.com/citra-emu/citra/issues/1749)
|
||||||
|
```
|
||||||
|
|
|
@ -1,2 +1,6 @@
|
||||||
# citra-games-wiki
|
# Citra Games Wiki
|
||||||
Citra games wiki
|
This is a database of how games will work in the Citra Nintendo 3DS Emulator using TOML. The site generated from this info can be found [here](https://citra-emu.org/game/).
|
||||||
|
|
||||||
|
If you interested in contributing, take a look at the [Contributing Guide](https://github.com/citra-emu/citra/blob/master/CONTRIBUTING.md).
|
||||||
|
|
||||||
|
For more info about Citra, go [here](https://citra-emu.org/). The repository for the Citra emulator can be found [here](https://github.com/citra-emu/citra), and the Citra website [here](https://github.com/citra-emu/citra-web).
|
||||||
|
|
Reference in New Issue