You are viewing a potentially older version of this package.
View all versions.
Interactive Terminal API
API focused on making interactable UI in the terminal
Date uploaded | 5 months ago |
Version | 1.1.3 |
Download link | WhiteSpike-Interactive_Terminal_API-1.1.3.zip |
Downloads | 486317 |
Dependency string | WhiteSpike-Interactive_Terminal_API-1.1.3 |
This mod requires the following mods to function
BepInEx-BepInExPack
BepInEx pack for Mono Unity games. Preconfigured and ready to use.
Preferred version: 5.4.2100Rune580-LethalCompany_InputUtils
API/Library for creating Unity InputActions with in-game re-binding support. Provides an alternative UI that allows for supporting mods to have in-game re-bindable keybinds.
Preferred version: 0.7.3README
InteractiveTerminalAPI
An API which focuses on making terminal applications where the player can interact with besides inputting text to it
Features
- Classes/interfaces where you can use to build your own terminal application
- You can also make your own custom classes that derive from these to be used as replacements
- Executes the application associated with a given text prompt entered in the terminal (if registered).
Important notices
- The mod itself doesn't do anything. It's just an API which other mod developers may wish to use for their own usages.
- It won't alter any vanilla terminal text on its own.
Documentation
- For the developers interested in using this, take your time at reading some stuff about it.
License
This API is under MIT License. Meaning that you can decide to take this API for your own things and customize it as you need, so long as you follow the license's requirements
CHANGELOG
1.2.0
- Implemented
BaseHierarchyElement
(and its derivedTextHierarchyElement
for text only) andBaseCursorHierarchyElement
(for selectable options) which aim to provide that visual of hierarchy splits or a tree. - Fixed some issues with
CursorElement
displaying its text when it has description. - Actually implemented
PreviousScreen
correctly for terminal application classes.
1.1.4
PageApplication
will change between screens when it reaches one of the boundaries of the current cursor menuPageCursorElement
doesn't display the page counter if it only contains one screen.
1.1.3
- Added
RegisterApplication
method where you can specify if the listed commands can be case sensitive or not
1.1.2
- Fixed issue with title being too big that would break the whole screen.
1.1.1
- Abstracted application types and added base classes
1.1.0
- Added
InteractiveCounterApplication
as possible application to use by the developers. - Added
CursorCounterElement
andCursorCounterMenu
which are entries where players manipulate their counter - Added
BoxedOutputScreen
which allows to show configurable output in the bottom right to what the developers want to show - Added
Active
andSelectInactive
attributes toCursorElement
to distinguish between entries with expected output and entries which will output an error when attempt. - Added sorting functionality to all applications which sort relevant cursor menus to defined sorting methods.
1.0.0
- Initial release