TNoodle 技术文档

TNoodle 是一款软件套件，包含世界魔方协会（WCA）官方的打乱程序。它主要由 Kotlin 语言编写的核心打乱代码，以及用于生成完全自主 JAR 文件的 UI 和服务器组成。

以下是关于 TNoodle 的安装指南、使用说明以及项目 API 使用文档的详细介绍。

1. 安装指南

TNoodle 使用 Gradle 构建系统，构建文件使用 Kotlin 语法编写。

环境准备

• 确保安装了 JDK（Java 开发工具包）。
• 确保网络连接正常，以便第一次构建时下载依赖。

安装步骤

1. 克隆项目到本地目录。

2. 执行以下命令获取项目任务概览：

   ./gradlew tasks
   

3. 当准备开发时，执行以下命令并在浏览器中访问 http://localhost:2014/scramble/：

   ./gradlew runDebug
   

4. 若要构建可分发的可执行 .jar 文件，执行以下命令：

   ./gradlew buildDebug
   

5. 使用以下命令从命令行运行 .jar 文件（将 $VERSION 标签替换为相应的版本号）：

   java -jar TNoodle-WCA-$VERSION.jar
   

重要提示：在任何官方比赛中，您绝不能使用自定义构建版本。 如果对此有任何疑问，请联系 WCA 董事会和 WRC。

2. 项目的使用说明

TNoodle 项目是一个多项目 Gradle 构建，每个子项目都有其独立的构件配置和 build.gradle 文件。

使用步骤

1. 使用 Gradle wrapper（gradlew 或 gradlew.bat）运行项目任务。
2. 在浏览器中访问 http://localhost:2014/scramble/ 以使用打乱程序。
3. 使用构建的 .jar 文件运行项目。

3. 项目 API 使用文档

目前文档中没有提供具体的 API 使用说明。建议直接查看项目源代码和相关的 Gradle 配置文件以获取详细信息。

4. 项目安装方式

TNoodle 的安装方式如前所述，通过 Gradle 构建系统进行。

• 使用 Gradle wrapper 运行项目。
• 构建可分发的 .jar 文件。
• 运行 .jar 文件。

确保遵循上述步骤，以正确安装和使用 TNoodle。