Go to file
Allison Mackenzie 64a3d0bdb9
Update ci.yaml
2023-09-20 16:01:51 -05:00
.github/workflows Update ci.yaml 2023-09-20 16:01:51 -05:00
bin Functional build system + differ (#6) 2023-09-08 07:48:04 -05:00
config update splat yaml files to remove /medievil/ 2023-09-20 16:00:35 -05:00
disk add putExtractedGameFilesHere 2023-09-20 15:58:20 -05:00
include Update format on game.h 2023-09-20 12:19:29 -05:00
src Added Various Functions (#22) 2023-09-19 14:13:16 -05:00
tools Make changes to CI 2023-09-20 12:12:51 -05:00
.clang-format Extract MEDIEVIL.EXE (#8) 2023-09-08 11:02:14 -05:00
.clang-tidy Make changes to CI 2023-09-20 12:12:51 -05:00
.gitignore Symbols fix (#16) 2023-09-13 18:26:59 -03:00
.gitmodules Multiple features (#12) 2023-09-08 20:19:07 -05:00
LICENSE Initial commit 2023-09-06 07:16:17 -05:00
Makefile Update Makefile 2023-09-20 15:55:16 -05:00
README.md Update README.md 2023-09-19 11:51:37 -05:00
diff_settings.py Fixed default diff parameters for game overlay (#17) 2023-09-14 01:47:33 +02:00

README.md

welcome banner

Discord Server

To help and join the discussion, please join our Discord Server here using this link: https://discord.gg/pBU8mD3k8z

Setup

Our project targets the US Retail PSX version of MediEvil 1. TBA - Being added to the Wiki for a full guide but basic guide will be written here.

Progress

TBA

How To

TBA...

To begin helping, you'll need to first understand the basics of Git version control system. This project uses a "Fork and Rebase" workflow, which means you'll need to click the fork button in the top right of the main repository page on GitHub to have the project in your own GitHub account. Make sure to fork ALL branches, not just main! You'll need to keep your version of the project up to date with this main project tree by having two remotes, yours and this one, hint: fetching all every time you begin working and before making Pull Requests and make changes on your fork instead of through a branch on the main repository like you may be used to. Additionally, since we're using a rebase workflow, you'll need to rebase your branch against a target branch (typically main tree's main or dev branch). More information concerning this will be provided at a later time. Finally, when making changes the changes will be squashed and merged into one commit with all your changes. Ideally, you'll make as little changes as needed for your function.

So, this is a decomp project which means you'll be converting assembly code to C code. Information on how to do that will be added here soon.

Note, for legal reasons, please do NOT commit copyrighted content (source code, game disks, rom/iso files, etc.) to this repository. This project works by decompiling retail disks through legal means, you MUST provide the real game to do this but said real game should not be committed to this repository!

TBA

Etc.

TBA test