HydroRoll Download - HydroRoll Source code download

HydroRoll

AI Source Code

v0.1.10

Download

release_img CodeQL

Cross-platform, multimodal, highly customized dice development framework

Welcome to HydroRoll [Water System], a high-performance, cross-platform, decentralized dice development framework written using Rust and Python based on scientific principles and empowered by multimodal models.

? This framework is mainly used to solve two problems : "How to better adapt to unpopular rule books" and "How to better realize human-computer interaction" . If you are the world master, rule book author, and a fan of artificial intelligence (natural language processing direction), then the water system may be your best choice.

? The core is written by Rust , with excellent performance and amazing speed.
? Top-level business logic written in Python is easy to use and faster to get started.
Based on the structure of the rules book, the veritable dice (manufacturing) factory.
⚡ You only need three instructions to quickly install and run existing rule packages, or develop your own dice system.
Flexible configuration and highly customized, just like building blocks and putting together puzzles.
? Optional expansion module, shiki -compatible lua module, shiki -compatible dice expression analysis module, etc.
? Cross-platform, connecting with onebot protocol, kook platform, dingtalk software, telegram , discord , minecraft ... and self-developed IM platforms.
? Compatible plug-in design, can write lua , python , and javascript scripts to empower additional functions, Blockly fool-style online visual writing plug-in.
? Meta- level dice roll expression parsing library, which can customize any parsing rules, or can be used to perform multiple operations in one instruction ~>Learn oneroll.
? Embedded AI tools - water system model workflow, webui manages the input and output and nesting relationships of each single task model, and realizes multi-task functions comparable to large models at low cost.
? Progressive learning framework, from writing simple nivis reply scripts, to writing lua and python scripts that meet small needs, to becoming the world leader to write your own rule package modules, and even training water system models, progressing layer by layer, easy to learn.
? More features are waiting for you to discover!

Installation and use

After installing 3.9+ version of Python , please install the pdm dependency globally, and then install the hydro-roll package globally.

pip install hydro-roll
# pip install hydro-roll[all] 安装所有组件
# pip install hydro-roll[basemodel] 安装基础模型
# pip install hydro-roll[dev] 安装开发包

Then use the atien command to build the robot template and run it.

atien new -b coc-example " HydroRollBot "
cd HydroRollBot
atien run

For more detailed usage methods, please refer to the official documentation.

Development examples

You can choose to start developing water-based dice from the frame end.

pip install iamai
iamai new " HydroRollDevBot "

iamai install hydro-roll --dist HydroRollDevBot
# cd HydroRollDevBot
# iamai install hydro-roll

Then you need to modify the configuration of the relevant adapters and hydro-roll plug-in in config.toml yourself.

Finally you may need a startup anchor - main.py .

 from iamai import Bot

bot = Bot ( hot_reload = True )

if __name__ == '__main__' :
    bot . run ()

python main.py

Community and Contribution

HydroRoll [water system] is not only a dice development framework, but also a growing community of users and framework developers.

We have listed the main community communication channels on the Water System’s documentation homepage. The best way to get in touch with core framework developers is to join the HydroRoll [water system] community forum Github Discussions.

If you want to start contributing to any projects under the HydroRoll-Team organization, see the Contribution Guide, which also includes specifications for submitting Issue and PullRequest.

Knowledge Q&A

“Who is suitable for the water system?”

World Master:	Rules Book Author. The water system is based on the standard architecture of the general rule package ( the corresponding language implementation of the rule book), which can generate a PDF version of the rule book and an online rule book browsing site for you with one click, and allows you to customize high-priority dice system built-in instructions in the rule package. A rule package is a dice system.
Plugin enthusiasts:	Downstream plug-in developer. Water system plug-ins can be written in lua , python , and javascript . At the same time, it supports online conversion of other dice-based plug-in files (such as Shiki 's Lua script, Qingguo's Python plug-in, Haixiao's JS plug-in, etc.) into plug-in scripts for the corresponding language of the water system. There is also a visual programming site built using Blockly to easily write plug-in scripts.
ML/AI enthusiasts:	The water system is inherited from the multimodal machine learning framework iamai , which can train and infer multiple models at the same time. Imagine your dice has its own unique personality...
kp and pl :	The rich water system rule package ecology and dice system ecology allow them who are eager to play unpopular rules to install the same rule package file in various dice systems that follow the water system GRPS standards.

"What is the water system? What is the water system not?"

The water system is a dice development framework: it allows you to develop your own dice system conveniently and quickly. Putting aside the artificial intelligence module, the first user in the water system is the world master.
The water system is not a specific dice system: but the water system has an official rule book and dice system implementation (portal). In the water system community, the concept of dice is weakened. A dice loaded with a unique rule package is a dice system (for the rule book corresponding to this rule package).