Skip to content

skirlez/nubbys-forgery

Repository files navigation

Nubby's Forgery

Nubby's Forgery is an API for Nubby's Number Factory. It allows you to extend various game systems, including items, perks, and supervisors.

If you use it, you don't have to focus on the implementation details of how your content is put into the game - or even more boring stuff, like saving and autosaving while working with other mods - it handles all of these for you.

Nubby's Forgery is a g3man mod.

Installing

Pick the version you want in https://github.com/Skirlez/nubbys-forgery/releases, and follow the instructions written with it.

Making a mod that utilizes on Forgery

Forgery has two example mods that you can look at.

The first has an item, supervisor, and perk: https://github.com/Skirlez/nubbys-forgery-example-mod

The second has one item and one challenge: https://github.com/Skirlez/nubbys-forgery-example-mod-2

The first mod has no GameMaker project and adds all of its functionality with the Catspeak scripting language, while the second mod has a GameMaker project, and all of its code an assets are included in it.

Additionally: See the Forgery wiki!

Status

Below is a list of what I want the API to support with a tick with what's implemented.

  • Items
  • Food
  • Perks
  • Supervisors
  • Nubby/Item Skins
  • Challenges
  • Special/Boss Rounds
  • Translations
  • Scripting via Catspeak
  • Scripting via Lua (?)

Building

See the wiki: Windows, Linux

License

The project is licensed under the LGPLv3 license (LICENSE.md). GPLv3 license text available in (COPY-OF-GPL-3.0.md) Catspeak is originally licensed under the MIT license (see catspeak_LICENSE)

Contributing

Please contribute

About

Modding API for Nubby's Number Factory

Resources

License

LGPL-3.0, MIT licenses found

Licenses found

LGPL-3.0
LICENSE.md
MIT
catspeak_LICENSE

Stars

Watchers

Forks

Packages

 
 
 

Contributors