TNoodle 项目使用教程

TNoodle 项目使用教程

tnoodleDevelopment for the official WCA scramble server项目地址:https://gitcode.com/gh_mirrors/tn/tnoodle

1. 项目的目录结构及介绍

TNoodle 是一个用于生成魔方比赛随机打乱序列的软件套件。项目的目录结构如下：

tnoodle/
├── buildSrc/
├── client/
├── deployable-gce/
├── deployable-jar/
├── gradle/
├── server/
├── .editorconfig
├── .gitignore
├── .jshintrc
├── Dockerfile
├── LICENSE
├── README.md
├── build.gradle.kts
├── genrsa.sh
├── gradlew
├── gradlew.bat
├── proguard-rules.pro
├── settings.gradle.kts

目录介绍

• buildSrc/: 包含 Gradle 构建脚本的共享代码和配置。
• client/: 客户端相关代码。
• deployable-gce/: Google Cloud Engine 部署相关代码。
• deployable-jar/: 可执行 JAR 文件部署相关代码。
• gradle/: Gradle 构建工具相关文件。
• server/: 服务器端相关代码。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .jshintrc: JavaScript 代码风格检查配置。
• Dockerfile: Docker 容器配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• build.gradle.kts: 主构建脚本。
• genrsa.sh: 生成 RSA 密钥的脚本。
• gradlew: Gradle 包装器脚本（UNIX）。
• gradlew.bat: Gradle 包装器脚本（Windows）。
• proguard-rules.pro: ProGuard 混淆规则配置。
• settings.gradle.kts: Gradle 设置脚本。

2. 项目的启动文件介绍

TNoodle 项目的启动文件主要是 gradlew 和 gradlew.bat。这两个文件是 Gradle 包装器脚本，用于在不同操作系统上执行 Gradle 任务。

启动文件介绍

• gradlew: 用于 UNIX 系统的 Gradle 包装器脚本。
• gradlew.bat: 用于 Windows 系统的 Gradle 包装器脚本。

使用方法：

./gradlew <task>  # 在 UNIX 系统上
gradlew.bat <task>  # 在 Windows 系统上

例如，要构建项目，可以运行：

./gradlew build  # 在 UNIX 系统上
gradlew.bat build  # 在 Windows 系统上

3. 项目的配置文件介绍

TNoodle 项目的配置文件主要包括 build.gradle.kts 和 settings.gradle.kts。

配置文件介绍

• build.gradle.kts: 主构建脚本，包含项目的构建配置和任务定义。
• settings.gradle.kts: 设置脚本，包含项目的模块和仓库配置。

build.gradle.kts

该文件定义了项目的构建配置，包括依赖管理、任务定义等。示例内容：

plugins {
    id("application")
}

repositories {
    mavenCentral()
}

dependencies {
    implementation("org.example:example-library:1.0.0")
}

application {
    mainClassName = "org.example.Main"
}

settings.gradle.kts

该文件定义了项目的模块和仓库配置。示例内容：

rootProject.name = "tnoodle"
include("client", "server")

通过这些配置文件，可以对项目进行构建、测试和部署等操作。

tnoodleDevelopment for the official WCA scramble server项目地址:https://gitcode.com/gh_mirrors/tn/tnoodle