Code Monkey home page Code Monkey logo

wawa's Introduction

wawa

Release License

A collection of libraries to help with the creation of mods in the game Keep Talking and Nobody Explodes.

Named after the respective toki pona word, meaning roughly "strong, powerful; confident, sure; energetic, intense".

This project has a dependency to Emik.Morsels, if you are building this project, refer to its README first.



Quick Start

If you are using Qkrisi's modkit, install it from Keep Talking ModKit > Plugins > wawa.Editors (By Emik) > Install.

Otherwise, you can install it manually by going to Releases, downloading the latest wawa.Editors .dll file, and placing it in ./Assets/Editor/Plugins/Managed/, not ./Assets/Plugins/Managed/.

Whichever method is used, wait for Unity to reload, and a new tab should appear named wawa. Hover over it, and download additional libraries as needed under Update.

Libraries

  • wawa.DDL - Implements the DDL pattern to safely expose game values, such as missions or strikes.
  • wawa.Editors - Editor-only assembly that adds a scaffolder to quickly create new modules, and an updater/downloader.
  • wawa.Extensions - Adds extension methods for KMFramework types to make hooking easier.
  • wawa.IO - Adds methods for KTaNE-related IO operations, such as Mod Settings, loading AssetBundles from the mod directory, or loading external libraries.
  • wawa.Modules - Adds ModdedModule, a base class that implements essential module behavior.
  • wawa.Optionals - Shared Maybe type. These libraries don't return null without wrapping it in this type.
  • wawa.Recall - Allows hooking onto other vanilla/modded modules and/or selectables. Useful for modules that require context of other modules.
  • wawa.TwitchPlays - Adds Twitch, a base class that hooks on a ModdedModule to add essential TwitchPlays behavior.
  • wawa.Unity - Adds CachedBehavior, eliminates overhead of Unity API calls without the need for explicit fields.

Contribute

  1. Set up Emik.Morsels.

  2. WINDOWS ONLY: You are required to extend the maximum path length and run this command:

    git config --global core.longpaths true
  3. Download and extract the full source code, or clone the repository:

    git clone https://github.com/Emik03/wawa.git
  4. Open the solution in your favorite IDE, or use the command-line directly to build it.

    dotnet build

Issues and pull requests are welcome to help this repository be the best it can be.

License

This repository falls under the MPL-2 license.

wawa's People

Stargazers

 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.