Giter VIP home page Giter VIP logo

rapatches's Introduction

RAPatches

This is a patch repository for RetroAchievements.org. Please open issues for requests and/or error reports. However, please do not make hash-linking requests here; patches in this repo are for hashes that have already been linked.

Goals

  • Eliminate the need for referencing GoodTools. It hasn't been updated in years and needs to be phased out.
  • Provide patches for various hacks, translations, subsets, bug fixes, etc. This includes older versions or abandoned projects where the patches are no longer available.

Contribution Guidelines

Bases and Formats

  • Patches must be intended to be used with No Intro, Redump, or FinalBurn Neo bases.
  • Do not submit patches to be used with GoodTools or TOSEC unless there are absolutely no other options. This should only be relevant with very few unlicensed or homebrew games.
  • The majority of patches are and should be in BPS format. IPS is allowed for NES due to headers and xDelta is allowed for larger files. DO NOT use any other format without a very good reason for doing so.

Naming Scheme

  • Patches for hacks that have their own RetroAchievements entry do not need a special naming scheme, at least until we come up with one.
  • Patches for Subsets should be named according to their RetroAchivements entry. For example: Mega Man [Subset - Bonus].
  • Patches for translations, bug fixes, etc. should be named after the base ROM with the patch info added. Follow this format (not all tags will be applicable): [MSU-1] -> Title -> (Region) -> (Base ROM Version) -> (Language/Patch Type) -> (Patch Version) -> (Patch Author) For example: ToeJam & Earl (USA, Europe, Korea) (Fr) (v0.9) (sky2048).bps. If something is unknown, then leave it blank. It can always be added later.
  • Languages must be abbreviated as so:
En English
Ja Japanese
Fr French
De German
Es Spanish
It Italian
Nl Dutch
Pt Portuguese
Sv Swedish
No Norwegian
Da Danish
Fi Finnish
Zh Chinese
Ko Korean
Pl Polish
El Greek
Ro Romanian
Fl Filipino
Ar Arabic
Tu Turkish
Eo Esperanto
La Latin

Compression

  • Patches are then compressed to either .zip or .7z, with those following a GAMEID-GameTitleWithoutSpaces naming scheme for linking purposes.
  • Whenever possible, please group similar patches together. If a game has five different Russian translations, we do not need a separate link for each one. Just throw them all into the same .zip/.7z. This applies to language patches as well as patches with various versions.
  • Please... please... stop using WinRAR for submissions. I always have to redo them because even .zips done with WinRAR do not allow editing the contents of the archive, which can happen frequently for some patches.

Readme

  • Be sure to include a readme.txt in the .zip/.7z that states which ROM the patch is intended to be used with.
  • The readme.txt files should follow this format:
    Use with:

    [Group, such as No Intro]
    [ROM file name and extension]
    [ROM Checksum]
    [CRC Checksum]
  • For [ROM Checksum], use the MD5 of a file instead of the RA Hash.

Other Info

  • While not required, people will forever remember you as a nice person if you include .cue files with patches for disc-based games. Filenames for .cue files should match the name of the patch.

rapatches's People

Contributors

televandalist avatar sanaki avatar timenoe avatar earthsouls avatar sporytike avatar bahamutvoid avatar mrownership avatar xtr4ceur avatar ben-ghazi avatar pinguupinguu avatar fretzi avatar guineu1 avatar tsearo avatar wandknight avatar darkc0m avatar delmaru avatar familymanp avatar gdeoo avatar limblessvector avatar zzker avatar ciymax avatar meleu avatar miccmike avatar soopercool101 avatar wholee avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.