Skip to content

junebug12851/pokered-save-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pokered Save Editor

Travis (.org) Scrutinizer Build Scrutinizer LGTM Grade Code Climate Code Climate Code Climate Depfu GitHub issues GitHub pull requests GitHub last commit GitHub GitHub code size in bytes GitHub repo size in bytes GitHub package version

About this project

We've reached 300 commits * Gasp * (•̀ᴗ•́)و ̑̑ !!!

This is aimed to be a complete Pokemon Red and Blue save editor, as in, all bytes and areas of the save file would be editable. It's designed to be very simple to jump-in and use right away intuitively with a well-designed interface. In other words the UI and UX are first-class citizens and as such the editing ui is designed to be easy, intuitive, and a bit fun to use.

The full save file made use by the game is editable, all bits and bytes, currently unused areas are not editable but this is a planned feature to implement.

Here are some of the features

All Font Characters

Typing names is meant to be as easy as simply using the keys on your keyboard however the game allows up to 255 different tiles, control codes, and variables to be used for names all of which are not directly typable on your keyboard. To keep from being unfair and leaving them out, shorthand syntax is used such as <f> or <B> to access all possible tile options. Even better, all 255 tiles and codes are available in a full slide-out virtual keyboard with mouseover tooltips on their shortcode equivalent.

Player

Player Name

Player Id and Money

Player Badges

Pokedex

Pokedex

Items

Bag Items

Pokemon

Party Pokemon

Area

Contrast

Sprites

Wild Pokemon

World

Events

Hidden Items

Hall of Fame

HoF

Wipe Unused Space

This features erases all unused data of your save file which there's a lot of. Your normal game will work as though nothing has changed however internally the save file has vastly been cleaned up which works especially well when viewing in editors yourself. Sometimes when submitting a bug report you may be asked to provide a cleaned up version of it since it can make degugging very easy.

Furthermore if you suspect tampering whether malicious or not such as extra code injected in your save file this will erase it.

Wipe Unused Space

A quick disclaimer

Despite significant work going into this project including countless sleepless nights and many many hours of planning and testing. I can't ever state this project is perfect and flawless. Things happen and things go wrong as with any app or game. I cannot be held liable for any damaged or corrupted games but I do want above anything to be told via the issue tracker if things do happen so I can try to find and issue a fix quickly.

Repository Size Note for Contributors and Builders

We try to keep the repository size as small as possible however you will find it's considered large for a git repo. This is a free and open source project and as such can't afford monthly costs or premium features. One of gits greatest creations is git-lfs which allows seamlessly seperating code from non-code and Github well supports this however Github, like 99% of other websites, want's to capitalize on this new feature and as such we can't use it. Microsoft is the only one that provides this feature completely free with no strings attached but at the cost of a completely private repo which doesn't work.

What this means is the repo size will have to include all non-code assets and not be able to use the git-lfs feature until it becomes free with no strings attached and this also means a much higher repo size for a normal git repository.

Still we need to try and keep assets small.

Hopefully Github will eliminate capitalization on git-lfs one day and allow open-source projects to be able to use it as it's almost a core feature to use in many projects.

License

This project has an easy license, it's licensed Apache 2, just do whatever as long as you credit me back.

This project makes use of quite a lot of external technologies and information which is listed in the credits section and thus may be licensed differently.

Contributing

Contributions are definately welcome, just fork and send a pull request.

Credits

  • Font Awesome Free (Web Fonts) - has 3 licenses "CC BY 4.0 License", "SIL OFL 1.1 License", and "MIT License" - Not my favorite but has some useful fonts.
  • IcoMoon Free (Web Fonts) - Attribution - All of the thousands of free font icons from the site at the time when it was downloaded.
  • PokeRed Team (Pokemon Red/Blue Source Code) - Public Domain, All the information I have came from those awesome people and their years of hard work.
  • Pokemon Red Bitmap Font Sprite Sheet (Pokemon Red/Blue Source Code) - Also came from the pokered team.
  • Electron (Desktop Platform) - License MIT, this is a desktop only app and this makes it possible very elegantly
  • Materialize (UI Kit) - License MIT, Provides a pretty and simple UI framework to build the interface on. This project isn't meant to be overly complex and to keep things striaght forward and useable.
  • Angular (Code Framework) - License MIT, About the only more complex aspect to the project but keeps a Single Page Application simple and does much of the heavy lifting.
  • SASS (UI Language) - License MIT, CSS improved
  • Typescript (Scripting language) - Apache 2 License, Eh, it comes with Angular
  • Google Material Icons - (More Icons!) - License Apache 2 License