tweak readme

Author: aratama

assets/registry.game.ron

@@ -64,95 +64,119 @@ GameRegistry(
             author: "のる",
             title: "茫漠たる庭",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play21154.html"
         ),
         "bgm/水のしたたる洞窟.ogg": (
             author: "",
             title: "",
-            appendix: ""
+            appendix: "",
+            url: ""
         ),
         "bgm/海岸4.ogg": (
             author: "",
             title: "",
-            appendix: ""
+            appendix: "",
+            url: ""
+        ),
+        "bgm/発見.ogg": (
+            author: "のる",
+            title: "発見",
+            appendix: "",
+            url: "https://dova-s.jp/bgm/play20256.html"
         ),
         // 拠点        
         "bgm/最果てのルージュ.ogg": (
             author: "のる",
             title: "最果てのルージュ",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play19795.html"
         ),
         // 通常
         "bgm/荒れ地の先へ.ogg": (
             author: "松浦洋介",
             title: "荒れ地の先へ",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play17195.html"
         ),
 
         "bgm/Tides_of_Adventure.ogg": (
             author: "K’z Art Storage",
             title: "Tides of Adventure",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play21129.html"
         ),
         "bgm/ダンジョンを踏破せし者.ogg": (
             author: "こーち",
             title: "ダンジョンを踏破せし者",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play20822.html"
         ),
         "bgm/森のいざない.ogg": (
             author: "MATSU",
             title: "森のいざない",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play12135.html"
         ),
         "bgm/迷宮.ogg": (
             author: "オオヒラセイジ",
             title: "迷宮",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play8802.html"
         ),
         "bgm/忘れられた神殿.ogg": (
             author: "KK",
             title: "忘れられた神殿",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play629.html"
         ),
         "bgm/midnight-forest-184304.ogg": (
             author: "Syouki Takahashi",
             title: "Midnight Forest",
             appendix: "",
+            url: "https://pixabay.com/music/ambient-midnight-forest-184304/"
         ),
         // ボス
         "bgm/悪魔との戦闘.ogg": (
             author: "今川彰人オーケストラ",
             title: "悪魔との戦闘",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play11175.html"
         ),
         "bgm/アクション・バトル.ogg": (
             author: "田中芳典",
             title: "アクション・バトル",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play12133.html"
         ),
         "bgm/Decisive_Battle.ogg": (
             author: "Make a field Music",
             title: "Decisive Battle",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play5746.html"
         ),
         "bgm/炎神の吐息.ogg": (
             author: "こおろぎ",
             title: "炎神の吐息",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play298.html"
         ),
         "bgm/Sacred_Sacrifice.ogg": (
             author: "ilodolly",
             title: "Sacred Sacrifice",
             appendix: "",
+            url: "https://dova-s.jp/bgm/play6142.html"
         ),
         "bgm/final-battle-trailer-music-217488.ogg": (
             author: "Ihor_Koliako",
             title: "FINAL BATTLE",
             appendix: "",
+            url: "https://pixabay.com/music/electronic-final-battle-trailer-music-217488/"
         ),
         "bgm/human-vs-machine-dark-orchestral-cinematic-epic-action-271968.ogg": (
             author: "Kulakovka",
             title: "Human vs Machine",
             appendix: "",
+            url: "https://pixabay.com/music/main-title-human-vs-machine-dark-orchestral-cinematic-epic-action-271968/"
         ),
         "audio/風が吹く1.ogg": (
             author: "",

readme.md

@@ -27,34 +27,29 @@ https://magiaforge.app/ (**Desktop Chrome only** for now)
 - `trunk build` to build web app and publish on GitHub Pages
 - `cargo +nightly fmt` to format
 
-Add `--features debug` to launch app in debug mode.
-Add `--features save` to launch app with Save feature.
+###### Feature Flags
+
+`cargo run --features xxxx,yyyy` to enable some debug features:
+
+- `debug` to enable debug draw.
+- `ingame` to skip main menu.
+- `item` to enable spell item cheat.
+
+### Authoring Tools
+
+This project depends on the following tools:
+
+- [LDtk](https://ldtk.io/) for level design
+- [Aseprite](https://www.aseprite.org/) for pixel art drawing
 
 ### Save Data Location
 
 On Windows, save data is stored in `%HOMEPATH%\AppData\Roaming\magiaforge`.
 
 In browsers, save data is stored in local storage under the key `magiaforge.magiaforgeconfig`.
 
-### Asset credits
-
-This game depends on the following assets:
-
-- 茫漠たる庭 https://dova-s.jp/bgm/play21154.html
-- 最果てのルージュ https://dova-s.jp/bgm/play19795.html
-- 荒れ地の先へ https://dova-s.jp/bgm/play17195.html
-- 悪魔との戦闘 https://dova-s.jp/bgm/play11175.html
-- Tides of Adventure https://dova-s.jp/bgm/play21129.html
-- ダンジョンを踏破せし者 https://dova-s.jp/bgm/play20822.html
-- 森のいざない https://dova-s.jp/bgm/play12135.html
-- 迷宮 https://dova-s.jp/bgm/play8802.html
-- 忘れられた神殿 https://dova-s.jp/bgm/play629.html
-- アクション・バトル https://dova-s.jp/bgm/play12133.html
-- Decisive Battle https://dova-s.jp/bgm/play5746.html
-- 炎神の吐息 https://dova-s.jp/bgm/play298.html
-- Sacred Sacrifice https://dova-s.jp/bgm/play6142.html
-- FINAL BATTLE (TRAILER MUSIC) https://pixabay.com/music/electronic-final-battle-trailer-music-217488/
-- Human vs Machine (dark orchestral cinematic epic action) https://pixabay.com/music/main-title-human-vs-machine-dark-orchestral-cinematic-epic-action-271968/
-- Midnight Forest https://pixabay.com/music/ambient-midnight-forest-184304/
-- 発見 https://dova-s.jp/bgm/play20256.html
-- (All Sound Effects) https://soundeffect-lab.info/
+### Asset Credits
+
+This game depends on free musical assets from https://dova-s.jp/ .
+See [the asset creadit file](assets/registry.game.ron) for more details (Also you can see BGM credit in pause menu).
+All Sound Effects are from https://soundeffect-lab.info/ .

src/level/chunk.rs

@@ -1,3 +1,4 @@
+use super::entities::SpawnEvent;
 use crate::constant::TILE_HALF;
 use crate::constant::TILE_SIZE;
 use crate::level::entities::Spawn;
@@ -11,8 +12,6 @@ use std::collections::HashMap;
 use std::collections::HashSet;
 use std::sync::LazyLock;
 
-use super::entities::SpawnEvent;
-
 #[derive(Clone, Debug, Copy)]
 pub struct Bounds {
     pub min_x: i32,

src/level/world.rs

@@ -1,3 +1,4 @@
+use super::chunk::position_to_index;
 use crate::constant::*;
 use crate::level::chunk::LevelChunk;
 use crate::level::tile::Tile;
@@ -7,8 +8,6 @@ use crate::spell::Spell;
 use bevy::prelude::*;
 use serde::Deserialize;
 
-use super::chunk::position_to_index;
-
 #[derive(Clone, PartialEq, Eq, Debug, Deserialize)]
 pub struct GameLevel(pub String);
 

src/script/cmd.rs

@@ -1,5 +1,6 @@
 use super::context::JavaScriptContext;
-use crate::actor::{Actor, ActorState};
+use crate::actor::Actor;
+use crate::actor::ActorState;
 use crate::audio::NextBGM;
 use crate::camera::GameCamera;
 use crate::component::counter::CounterAnimated;
@@ -9,7 +10,8 @@ use crate::entity::light::spawn_flash_light;
 use crate::hud::overlay::OverlayEvent;
 use crate::language::Dict;
 use crate::level::tile::Tile;
-use crate::level::world::{GameLevel, GameWorld};
+use crate::level::world::GameLevel;
+use crate::level::world::GameWorld;
 use crate::registry::Registry;
 use crate::se::SEEvent;
 use crate::spell::Spell;

src/script/value.rs

@@ -1,5 +1,9 @@
 use bevy::math::Vec2;
-use boa_engine::{js_string, object::ObjectInitializer, property::Attribute, Context, JsValue};
+use boa_engine::js_string;
+use boa_engine::object::ObjectInitializer;
+use boa_engine::property::Attribute;
+use boa_engine::Context;
+use boa_engine::JsValue;
 
 #[allow(dead_code)]
 pub fn vec2_to_tuple(v: Vec2, context: &mut Context) -> JsValue {