Support English readme

cloudhu · Nov 26, 2024 · 4169b36 · 4169b36
1 parent c331c83
commit 4169b36
Show file tree

Hide file tree

Showing 3 changed files with 124 additions and 25 deletions.
diff --git a/README-EN.md b/README-EN.md
@@ -0,0 +1,78 @@
+# skywalker2088
+Vampire survivor like game, cosmic science fiction wasteland, players drive the spaceship to roam in the universe, fight monsters to collect equipment to upgrade the spaceship, research technology tree, explore the remains of civilization.
+[中文](https://github.com/cloudhu/skywalker2088/README.md)
+______
+# 0. Introduce
+- Game type: Vampire survivor like game
+- Game background: The player is a space patrol, in a patrol mission found a pirate ship, during the pursuit process accidentally sucked into a black hole, into a cosmic relic, the universe number is 2088.
+  In order to return to their own space, players need to drive spaceships to fight monsters, collect equipment, research technology tree, and explore the remains of civilization, and in the process, players gradually uncover the reason of the destruction of this cosmic civilization.
+  The final goal is that player needs to find a way to return to his own universe as soon as possible, and bring the case of 2088 to cosmic scientists, perhaps they have a way to avoid the collapse of their own cosmic civilization.
+______
+# 1. Game Design
+______
+1. Energy collection: The spaceship has a conversion core that converts space ore into energy, and can also absorb the energy crystal core on the transformed space monster, which provides a steady supply of energy for the spaceship and the energy required for upgrading;
+2. Spaceship upgrade: The core and components of Mecha monsters can be used as materials for spaceship upgrade, and the direction of upgrade mainly includes engine upgrade (faster moving speed), weapon upgrade, defense upgrade... Upgraded ships can deal with more powerful monsters;
+3. Science and technology research: Through the exploration of civilization relics, players can collect science and technology points, unlock the science and technology tree, so that the spacecraft has more powerful skills, such as laser rays, gravitational wave detectors, drone clusters, super particle cannons...
+4. Civilization Relics: As the level increases, players can explore more advanced and dangerous civilization relics, to obtain more powerful cores, more energy and technology points;
+5. Art style: Space, science fiction, wasteland, civilization ruins.
+
+## 1.1 Control
+______
+1. Move: left mouse button for ship navigation (TODO: keyboard arrow keys and joystick support)
+2. Pause/Resume: keyboard space bar (TODO: Start button on gamepad)
+3. return to the main menu: keyboard ESC (todo: controller return key)
+4. Full screen/window switch: F11 keyboard key (todo: controller Settings menu)
+5. Zoom: mouse wheel /PageUp = +, PageDown = - (Todo: handle Trigger zoom)
+______
+##  1.2. Level Design
+The levels are mainly divided into: 1. Drama level; 2. Relic exploration level; 3. Infinite Abyss Level.
+###  1.2.1  Drama level
+todo……
+###  1.2.2  Relic exploration level
+todo……
+###  1.2.3  Infinite Abyss Level
+todo……
+
+______
+# 2.  Develop Log
+## 2.1  Finished
+- [x] Use `cargo generate thebevyflock/bevy_new_2d` to Generated 2d game templates,reference [bevy_new_2d](https://github.com/TheBevyFlock/bevy_new_2d)；
+- [x] Core code is copied from [ASCII Space Shooter](https://github.com/JamesHDuffield/ascii-rust) And optimized the structure to adapt Bevy_new_2d template；
+- [x] Pause/Resume
+- [x] support wasm
+- [x] Enemy AI
+- [x] Game audio
+- [x] Use [bevy_asset_loader](https://github.com/NiklasEi/bevy_asset_loader) to optimize the resource loading process
+- [x] Use [bevy_kira_audio](https://github.com/NiklasEi/bevy_kira_audio) to Optimize sound play logic and performance
+- [x] Supports full screen/window switching and mouse wheel zooming (November 15, 2024)
+- [x] Configure property values and multiple languages with csv (English and Chinese are supported first)
+
+## 2.2 待实现列表 TODO List
+- [ ] Support gamepad handle operation input （employ [leafwing-input-manager](https://github.com/leafwing-studios/leafwing-input-manager) as input plugin）
+- [ ] Use [LDTK](https://github.com/Trouv/bevy_ecs_ldtk) to develop game levels
+- [ ] Level loading
+- [ ] Level switching
+- [ ] Spawner for different type of enemies
+- [ ] Collision detection with a physics engine
+- [ ] Animation module
+- [ ] Game UI
+- [ ] Game saving, file reading, auto save(employ [bevy_pkv](https://github.com/johanhelsing/bevy_pkv) plugin)
+- [ ] Multiplayer support
+
+# 3.  For Developers
+## 3.1  Game Engine
+Game Engine:[Bevy](https://bevyengine.org/)
+## 3.2  Develop Template
+- `cargo generate thebevyflock/bevy_new_2d`
+- [ASCII Space Shooter](https://github.com/JamesHDuffield/ascii-rust)
+
+## 3.3  Compile Optimism
+- [Sccache](https://github.com/mozilla/sccache) : `cargo install sccache --locked`
+
+## 3.4  cmd
+- Rust formation： `cargo fmt`
+- clippy：`cargo clippy --locked --workspace --all-targets --all-features -- --deny warnings`
+- develop run：`cargo run`
+
+# 4.  Showcase
+[Itch.io](https://cloudhu.itch.io/skywalker2088)
diff --git a/README.md b/README.md
@@ -1,53 +1,69 @@
-# skywalker2088
+# skywalker2088  天行者2088
 吸血鬼幸存者类型游戏，宇宙科幻废土，玩家驾驶飞船在宇宙中漫游，打怪收集装备升级飞船，研究科技，探索文明的遗迹。
-
+Vampire survivor like game, cosmic science fiction wasteland, players drive the spaceship to roam in the universe, fight monsters to collect equipment to upgrade the spaceship, research technology tree, explore the remains of civilization.
+[English](https://github.com/cloudhu/skywalker2088/README-EN.md)
 ______
-# 0. 简介
+# 0. 简介 Introduce
 - 游戏类型：吸血鬼幸存者like
+- Game type: Vampire survivor like game
 - 游戏背景：玩家是一名太空巡警，在一次巡逻任务中发现了一艘海盗船，在追捕过程中意外地被一个黑洞吸入，进入到一个宇宙遗迹中，这个宇宙的编号是2088，
         为了回到自己所在的宇宙空间，玩家需要驾驶太空飞船打怪、搜集装备、研究科技、探索文明的遗迹，在这个过程中玩家逐渐揭开这个宇宙文明毁灭的
         真相，他需要尽快想办法回到自己所在的宇宙，将2088的案例带给宇宙科学家们，也许他们有办法避免自己宇宙的文明走向崩坏。
-
+- Game background: The player is a space patrol, in a patrol mission found a pirate ship, during the pursuit process accidentally sucked into a black hole, into a cosmic relic, the universe number is 2088.
+  In order to return to their own space, players need to drive spaceships to fight monsters, collect equipment, research technology tree, and explore the remains of civilization, and in the process, players gradually uncover the reason of the destruction of this cosmic civilization.
+  The final goal is that player needs to find a way to return to his own universe as soon as possible, and bring the case of 2088 to cosmic scientists, perhaps they have a way to avoid the collapse of their own cosmic civilization.
 ______
-# 1. 玩法设计
+# 1. 玩法设计 Game Design
 1. 能量收集：太空飞船拥有将太空矿石转化成能量的转化内核，也能吸收转化太空怪物身上的能量晶核，这些能量为飞船提供源源不断的能源供给和升级所需的能量；
 2. 飞船升级：机甲类怪物的内核和部件可以作为飞船改造升级的材料，升级改造的方向主要有引擎升级（更快的移动速度）、武器升级、防御升级……升级后的飞船可以应对更加强大的怪物；
 3. 科技研究：通过对文明遗迹的探索，玩家可以收集科技点，解锁科技树，使太空飞船拥有更加强大的技能，比如激光射线、引力波探测器、无人机集群、超能粒子炮……
 4. 文明遗迹：随着等级提升，玩家可以探索更加高级且危险的文明遗迹，从而获取更加强大的内核，更多的能量和科技点；
 5. 美术风格：太空、科幻、废土、文明遗迹。
+______
+1. Energy collection: The spaceship has a conversion core that converts space ore into energy, and can also absorb the energy crystal core on the transformed space monster, which provides a steady supply of energy for the spaceship and the energy required for upgrading;
+2. Spaceship upgrade: The core and components of Mecha monsters can be used as materials for spaceship upgrade, and the direction of upgrade mainly includes engine upgrade (faster moving speed), weapon upgrade, defense upgrade... Upgraded ships can deal with more powerful monsters;
+3. Science and technology research: Through the exploration of civilization relics, players can collect science and technology points, unlock the science and technology tree, so that the spacecraft has more powerful skills, such as laser rays, gravitational wave detectors, drone clusters, super particle cannons...
+4. Civilization Relics: As the level increases, players can explore more advanced and dangerous civilization relics, to obtain more powerful cores, more energy and technology points;
+5. Art style: Space, science fiction, wasteland, civilization ruins.
 
-## 1.1 操作
+## 1.1 操作 Control
 1. 移动：鼠标左键为飞船导航（TODO：键盘方向键和手柄摇杆支持）
 2. 暂停/恢复：键盘空格键（TODO：手柄Start按键）
 3. 返回主菜单：键盘ESC（todo：手柄return返回按键）
 4. 全屏/窗口切换：F11键盘按键（todo：手柄设置菜单）
 5. 缩放：鼠标滚轮/PageUp = +、PageDown = -（Todo：手柄左右Trigger缩放）
-
 ______
-# 2. 关卡设计
+1. Move: left mouse button for ship navigation (TODO: keyboard arrow keys and joystick support)
+2. Pause/Resume: keyboard space bar (TODO: Start button on gamepad)
+3. return to the main menu: keyboard ESC (todo: controller return key)
+4. Full screen/window switch: F11 keyboard key (todo: controller Settings menu)
+5. Zoom: mouse wheel /PageUp = +, PageDown = - (Todo: handle Trigger zoom)
+______
+##  1.2. 关卡设计 Level Design
 关卡主要分为：1.剧情类关卡；2.遗迹探索类关卡；3.无限深渊关卡。
-## 2.1 剧情关卡
+The levels are mainly divided into: 1. Drama level; 2. Relic exploration level; 3. Infinite Abyss Level.
+###  1.2.1 剧情关卡 Drama level
 todo……
-## 2.2 遗迹
+###  1.2.2 遗迹 Relic exploration level
 todo……
-## 2.3 无限深渊
+###  1.2.3 无限深渊 Infinite Abyss Level
 todo……
 
 ______
-# 3. 开发记录
-## 3.1 已实现列表
+# 2. 开发记录 Develop Log
+## 2.1 已实现列表 Finished
 - [x] 使用`cargo generate thebevyflock/bevy_new_2d`生成的2d游戏模板作为[游戏基础开发框架](https://github.com/TheBevyFlock/bevy_new_2d)；
 - [x] 从[ASCII Space Shooter](https://github.com/JamesHDuffield/ascii-rust)开源项目Copy核心逻辑代码，并优化结构；
-- [x] 暂停游戏
-- [x] WASM支持
-- [x] 敌人AI实现
-- [x] 游戏音效
-- [x] 使用[bevy_asset_loader](https://github.com/NiklasEi/bevy_asset_loader)优化资源加载
+- [x] 暂停游戏 Pause/Resume
+- [x] WASM支持 support wasm
+- [x] 敌人AI实现 Enemy AI
+- [x] 游戏音效 Game audio
+- [x] 使用[bevy_asset_loader](https://github.com/NiklasEi/bevy_asset_loader)优化资源加载 Use [bevy_asset_loader](https://github.com/NiklasEi/bevy_asset_loader) to optimize the resource loading process
 - [x] 使用[bevy_kira_audio](https://github.com/NiklasEi/bevy_kira_audio)优化音效播放逻辑和性能
 - [x] 支持全屏/窗口切换和鼠标滚轮缩放（2024年11月15日）
 - [x] 通过csv来配置数值和多语言（先支持中英双语）
 
-## 3.2 TODO List
+## 2.2 待实现列表 TODO List
 - [ ] 支持手柄操作输入（我喜欢用手柄玩，没有手柄可以用键鼠，考虑使用[leafwing-input-manager](https://github.com/leafwing-studios/leafwing-input-manager)插件）
 - [ ] 多语言支持（先弄中英文双语，考虑使用[fluent](https://github.com/kgv/bevy_fluent)插件）
 - [ ] [LDTK](https://github.com/Trouv/bevy_ecs_ldtk)软件编辑关卡
@@ -60,17 +76,20 @@ ______
 - [ ] 游戏存档、读档、自动保存(考虑使用[bevy_pkv](https://github.com/johanhelsing/bevy_pkv)插件开发)
 - [ ] 本地多人模式
 
-# 4. 开发指南
-## 4.1 游戏引擎：[Bevy](https://bevyengine.org/)
-
-## 4.2 游戏模板
+# 3. 开发指南 For Developers
+## 3.1 游戏引擎 Game Engine
+   Game Engine:[Bevy](https://bevyengine.org/)
+## 3.2 游戏模板 Develop Template
 - 使用`cargo generate thebevyflock/bevy_new_2d`生成的2d游戏模板
 - 从[ASCII Space Shooter](https://github.com/JamesHDuffield/ascii-rust)开源项目Copy核心逻辑代码
 
-## 4.3 编译优化
+## 3.3 编译优化 Compile Optimism
 - 使用[Sccache](https://github.com/mozilla/sccache)作为编译缓存工具，安装命令：`cargo install sccache --locked`
 
-## 4.4 常用命令列表
+## 3.4 常用命令列表 cmd
 - Rust格式化： `cargo fmt`
 - clippy提交检查：`cargo clippy --locked --workspace --all-targets --all-features -- --deny warnings`
 - 本地开发运行：`cargo run`
+
+# 4. 发布 Showcase
+[Itch.io](https://cloudhu.itch.io/skywalker2088)
diff --git a/src/screens/title.rs b/src/screens/title.rs
@@ -32,6 +32,7 @@ fn spawn_title_screen(
             children
                 .button("Duolingo", fonts.primary.clone())
                 .observe(set_lang);
+            #[cfg(not(target_family = "wasm"))]
             children
                 .button("Toggle Fullscreen", fonts.primary.clone())
                 .observe(toggle_fullscreen);
@@ -80,6 +81,7 @@ fn stop_title_music(mut next_bgm: ResMut<NextBgm>) {
     *next_bgm = NextBgm(None);
 }
 
+#[cfg(not(target_family = "wasm"))]
 fn toggle_fullscreen(_trigger: Trigger<OnPress>, mut window_query: Query<&mut Window>) {
     let mut window = window_query.single_mut();
     window.mode = match window.mode {