Coder Social home page Coder Social logo

pancake's Introduction

Pancake

TODO: add logo

Pancake is a library to interface with libsm64, a modified version of the SM64 decompilation currently included with Wafel.

FAQ

I'm probably going to get these questions a lot, so here goes.

Why "Pancake"?

There are two tools currently in use by the SM64 TASing community: STROOP and Wafel, which together comprise the name of a very certain Dutch dessert: stroopwafel. Since this library complements both STROOP and Wafel, I decided to go with the name Pancake, since people eat pancakes with stroopwafels, and as a subtle nod to pannenkoek2012.

If STROOP and WAFEL are both acronyms, what does PANCAKE stand for?

Pointer ANalyzer Collecting Access to Known Engine.
(shoutouts to Notchmath for coming up with like 75% of this)

Is it faster than Wafel API?

Pancake is likely slightly slower, but it is still blazing fast.
Reasons include:

  • libdwarf (the only DWARF parser I found for Windows) is slow
  • Wafel caches the address of globals during data path compilation, Pancake doesn't (for safety reasons)

How do I use it?

Download from the GitHub releases, the folders in your zip should explain themselves. Documentation is available on this repo's GitHub Pages.

If you want to build it on your own computer, see below.

Building it yourself

This is just your standard CMake project. As such, you can build it like so:

mkdir build && cd build
cmake ..
cmake --build .

I recommend using the Ninja generator if you're using VSCode, as that guarantees access to a compilation database. As a sidenote, no one has built libsm64 on a Mac, and as such you can only use Windows or Linux.

I think I will need more setup to allow use of find_package, but ExternalProject should work OK.

Legal issues, acknowledgements, etc.

I am currently not willing to license Pancake as open source, simply due to the non-licensing of the Super Mario 64 decompilation. If I can be 100% sure Nintendo isn't going to chase after me, I will officially open-source this.

pancake's People

Contributors

jgcodes2020 avatar wheatman avatar

Watchers

James Cloos avatar  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.