MtgDesktopCompanion 项目教程
1. 项目的目录结构及介绍
MtgDesktopCompanion 项目的目录结构如下:
MtgDesktopCompanion/
├── bin/
│ ├── mtg-desktop-companion.bat
│ └── mtg-desktop-companion.sh
├── src/
│ ├── main/
│ └── test/
├── target/
│ └── executable/
│ └── bin/
│ ├── mtg-desktop-companion.bat
│ └── mtg-desktop-companion.sh
├── README.md
├── pom.xml
└── ...
目录结构介绍
- bin/: 包含项目的启动脚本,
mtg-desktop-companion.bat
用于 Windows 系统,mtg-desktop-companion.sh
用于 Unix 系统。 - src/: 包含项目的源代码,分为
main/
和test/
两个子目录,分别存放主代码和测试代码。 - target/: 构建后的输出目录,
executable/bin/
中包含构建后的启动脚本。 - README.md: 项目的说明文档。
- pom.xml: Maven 项目的配置文件。
2. 项目的启动文件介绍
启动文件
- mtg-desktop-companion.bat: 用于 Windows 系统的启动脚本。
- mtg-desktop-companion.sh: 用于 Unix 系统的启动脚本。
启动步骤
- 确保已安装 Java 21 或更高版本。
- 下载并解压最新版本的 MtgDesktopCompanion。
- 进入解压后的
/bin
目录。 - 运行
mtg-desktop-companion.bat
(Windows)或mtg-desktop-companion.sh
(Unix)。
3. 项目的配置文件介绍
pom.xml
pom.xml
是 Maven 项目的配置文件,包含项目的依赖、构建配置等信息。
配置步骤
- 克隆项目到本地:
git clone https://github.com/nicho92/MtgDesktopCompanion.git
- 进入项目目录:
cd MtgDesktopCompanion
- 使用 Maven 构建项目:
mvn -DskipTests clean install
- 进入构建后的启动目录:
cd target/executable/bin
- 运行启动脚本:
或./mtg-desktop-companion.sh # 对于 Unix 系统
./mtg-desktop-companion.bat # 对于 Windows 系统
通过以上步骤,您可以成功构建并启动 MtgDesktopCompanion 项目。