Giter Club home page Giter Club logo

citrus's Introduction

citrus

citrus is a simplified 3DS homebrew library, originally known as ctrcommon. It is split into various distinct "modules":

  • core - Main module, initializes everything else and contains the most basic functions.
  • app - Application management functions.
  • battery - Battery status functions.
  • err - Error management functions.
  • fs - Filesystem functions that aren't covered by the standard library.
  • gpu - OpenGL-esque GPU functions.
  • gput - GPU Tools; provides a default shader, a matrix stack, and higher-level drawing functions.
  • hid - Input functions.
  • ir - Infrared communication functions.
  • news - Notification management functions.
  • nor - NVRAM access functions.
  • snd - Sound playback functions.
  • soc - Internal module for initializing and cleaning up sockets.
  • utf - UTF conversion functions.
  • wifi - WiFi status functions.

Core functions:

  • ctr::core::init() - Must be called before using any citrus functions.
  • ctr::core::cleanup() - Must be called after you're finished using citrus functions, usually on exit.
  • ctr::core::running() - Performs the standard APT main loop and returns whether or not the application should terminate.
  • ctr::core::launcher() - Returns whether the application was launched from the homebrew launcher.
  • ctr::core::time() - Returns the current time in milliseconds.

citrus also comes with a small set of tools, including bannertool, makerom, template RSFs, and a template Makefile.

An example of citrus and its tools in use can be found here.

Requires devkitARM, the great-refactor branch of ctrulib, and picasso to build. Run 'make' to build, and run 'make install' to install it to your devkitPro directory.

TODO

  • Standard UI module, to make the creation of UIs easy.

citrus's People

Contributors

rsduck avatar

Watchers

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