Giter Club home page Giter Club logo

wariosave's Introduction

WarioSave

license GitHub release (latest by date) GitHub Workflow Status GitHub issues GitHub GitHub all releases

The WarioSave library is a C library designed to read the player's save data in Super Mario Land 3: Wario Land. It provides functions to initialize player save data and calculate the completion rate for each level in the game.

Building the Library

The library can be built using the provided Makefile. The Makefile is set up to use the GCC compiler, but this can be changed by modifying the CC variable in the Makefile.

To build the library, navigate to the directory containing the Makefile and run the make command.

make

This will compile the source files in the src directory and output the resulting object files to the build/release directory.

Using the Library

To use the library, include the header files in your C source files and link against the libwariosave.a library during the linking stage of your build process.

#include "wariosave.h"

For detailed information on the functions provided by the WarioSave library, see the API Documentation.

Building the Example

The WarioSave library includes an example application that demonstrates how to use the library. The example application can be built using the provided Makefile in the root directory of the project.

Prerequisites

  • GCC compiler
  • Make build automation tool

Build Steps

  1. Navigate to the root directory of the project where the Makefile is located.

  2. Run the make command:

make

This command will compile the source files located in the src directory and output the resulting object files to the build directory. It will also generate dependency files in the deps directory.

The Makefile uses the GCC compiler (gcc) by default, but this can be changed by modifying the CC variable in the Makefile.

The INCLUDES variable in the Makefile specifies the directories where the compiler should look for header files. By default, it is set to look in the include/ directory in the root of the project, and the include/ directory in the lib/ directory.

The resulting application will be named wario-save, as specified by the APP_NAME variable in the Makefile.

Usage

Once the wario-save application is built, you can run it from the command line. The application takes a single argument, which is the path to the Wario game save file you want to analyze.

Here's an example of how to use the wario-save application:

./wario-save /path/to/your/savefile.sav

This command will load the specified save file, analyze the data, and print out the player's lives, hearts, total coins, game completion status, and the completion rate for each level.

Acknowledgements

  • Wario Land Disassembly (wl): This project provided valuable insights and code that helped me understand the structure of Wario game save files.

License

The WarioSave library is distributed under the MIT License. See the accompanying LICENSE.txt file for more details, or visit http://opensource.org/licenses/MIT.

wariosave's People

Contributors

savaughn avatar

Watchers

 avatar

wariosave's Issues

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.