Pixiv @void_0
675 字
3 min
Dark Survivor 開発 Wiki
はじめに
このページは、ゲーム『Dark Survivor』の開発に参加するための情報をまとめたWikiです。 開発を始める前に、このページを一読してください。
開発環境のセットアップ
開発に必要なソフトウェアです。各カードから公式サイトにアクセスし、ダウンロードとインストールを行ってください。
Zed
高速でモダンなコードエディタ
Git
ソースコードのバージョン管理システム
Redot Engine
オープンソースのゲームエンジン
Gitの基本的な使い方
プロジェクトのソースコードはGitで管理されています。基本的な操作方法を覚えておきましょう。
リポジトリの場所プロジェクトのGitHubリポジトリは以下です。
Waiting for api.github.com...
リポジトリのクローン
最初に、上記のリポジトリをローカル環境にコピー(クローン)します。
git clone https://github.com/Sofia-Luceat-Project/dark-survivor.git最新の変更を取り込む
作業を始める前にコンフリクト(変更の衝突)を避けるため、作業を始める前には必ずリモートリポジトリの最新の変更を取り込みましょう。
git pull origin mainブランチの作成と切り替え
新しい機能の実装やバグ修正など、作業単位でブランチを作成します。
# "feature/new-feature" という名前で新しいブランチを作成し、そのブランチに切り替えるgit checkout -b feature/new-feature
# ブランチに切り替えるgit checkout feature/new-feature変更を記録する
変更したファイルをステージングし、コミットメッセージを付けて記録します。
# 変更したファイルをすべてステージングするgit add .
# コミットメッセージを付けてコミットするgit commit -m "feat: 新機能を追加"変更をリモートに送信する
ローカルでの変更をリモートリポジトリに反映させます。
git push origin feature/new-feature開発ルール
開発を円滑に進めるために以下のルールを守って開発を進めてください。
ブランチ運用ルール
mainブランチには直接コミットせず、開発用のブランチ(例:develop)からブランチを作成してください。- 機能追加は
feature/、バグ修正はfix/などのプレフィックスをブランチ名に付けます。 - 作業が完了したら、プルリクエスト(またはマージリクエスト)を作成し、レビューを受けてからマージします。
コミットメッセージ
コミットメッセージは、変更内容が分かりやすいように記述します。
フォーマット: <type>: <subject>
- 例:
feat: プレイヤーの移動機能を追加 - 例:
fix: 敵が動かなくなるバグを修正
コーディングスタイル
Godotスタイルガイド
- ファイル名:
snake_case(例:player_controller.gd,main_menu.tscn) - ノード名:
PascalCase(例:Player,EnemySpawner) - クラス名 (class_name):
PascalCase(例:PlayerController) - シグナル名:
past_tense(過去形)(例:tree_entered,health_depleted)
コンポーネント指向アプローチ
player.tscnやenemy.tscnのように、1つのエンティティは複数の子ノード(コンポーネント)から構成されます。- 例えば、
Playerシーンは「移動を処理するスクリプト」「ステータスを管理するノード」「アニメーションを制御するノード」といったように、機能ごとにノードが分割されています。 - これにより、機能の再利用性が高まり、単一のスクリプトが肥大化するのを防ぎます。
Dark Survivor 開発 Wiki
https://sofia-luceat-project.github.io/posts/wiki/dark-survivor-dev-wiki/