Code Monkey home page Code Monkey logo

basemod's Introduction

BaseMod

BaseMod provides a number of hooks and a console.

Requirements

General Use

  • Java 8+

Development

  • Java 8+
  • Maven

Building

  1. Run mvn package

Installation

  1. Copy target/BaseMod.jar to your ModTheSpire mods directory.

Console

Default hotkey is `, can be changed from BaseMod's settings screen.

  • info toggle Settings.isInfo
  • relic [id] generate relic
  • relic r [id] lose relic

For Modders

Hooks

Subscription handling

  • BaseMod.subscribeTo...(this)
  • BaseMod.unsubscribeFrom...(this)

Subscriptions

Implement the appropriate interface (ex. basemod.interfaces.PostInitializeSubscription)

  • receivePostInitialize() - One time only, at the end of CardCrawlGame.initialize()
  • receiveRender(SpriteBatch) - Under tips and the cursor, above everything else
  • receivePostRender(SpriteBatch) - Above everything
  • receivePreUpdate() - Immediately after input is handled
  • receivePostUpdate() - Immediately before input is disposed

Mod Badges

Currently only has full support for the badges themselves. Clicking any will open the BaseMod settings page for now.

  • BaseMod.registerModBadge(Texture texture, String modName, String author, String description)

Changelog

v1.0.0

  • Initial release

v1.0.1

  • Scale console by Settings.scale
  • Prevent game hotkeys from activating while console is visible

v1.1.0

  • Add mod badges
  • Add initial support for mod settings screens
  • Add relic console command
  • Add option to change console keybind on BaseMod settings screen

v1.1.1

  • Scale mod badges by Settings.scale
  • Scale mod settings screens by Settings.scale

basemod's People

Contributors

flipskiz avatar t-larson avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 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.