Aizuna イントロダクション

実行ファイル の取得

インストール

Rust nightly 環境の準備

Rustを参照して開発環境(rustup, cargo)を準備してください。

nightly toolchain をインストールします。

rustup install nightly

コンパイル

次のどちらかを選択してください。

  • A. GitHub から直接インストール
  • B. ソースコードからインストール
A.GitHub から直接インストール

GitHubのrepositoryから直接インストールします。

cargo +nightly install --git https://github.com/hanepjiv/aizuna.git

nightly toolchain を指定するため +nightly が必要です。

B.ソースコードからインストール

GitHubのrepositoryからソースコードを入手します。

git clone https://github.com/hanepjiv/aizuna.git
cd asizuna
インストール

nightlyでコンパイルすることを指示し、cargoコマンドでインストールします。

cargo +nightly install
aizuna
インストールをしないで実行

cargo runコマンドでインストールせずに実行することもできます。

cargo +nightly run --release
+nightlyの省略
rustup override set nightly

プロジェクトフォルダ毎に toolchain を override 指定することができます。 詳しくは rustup のヘルプを参照してください。

初回起動

設定ファイルの新規作成

初回起動で設定ファイルが無い場合、設定ファイルを新規作成するかを問われます。

create config file? "${HOME}/.config/aizuna/config.toml" [Y/n]:

--root オプションを付与して実行すると設定ファイルを参照するディレクトリを指定できます。 デフォルトでは ${HOME}/.confog/aizuna/ を参照します。

aizuna --root ./

cargo runで起動する場合は次のように指定します。

cargo +nightly run --release -- --root ./

設定ファイルを新規作成すると、デバッグコンソールのみに接続した状態で起動します。

Console::new: *** Caution! This is a DEBUG console. ***
Console: Spawn

詳しくは、Aizuna 設定を参照してください。

基本コマンド

Aizunaは接頭辞(prefix: デフォルトでは",")から始まる文字列をコマンドとして認識します。

,help

先ずは ",help" コマンドを入力してください。

,help
Console: Whisper:
Aizuna v0.1.0:
 ,help      Print this message.
 ,user/ ,u  Print User info.
 ,session / ,s  Session controll.
 ,[0-9]*d[0-9]* Dice roll. etc. ,2d6 / ,3d / ,d10
 ,quit / ,Q Aizuna logout server. Need administrator's authority.
 ,database  Dump database. Need administrator's authority.

入力と出力にプロンプト(" >" のような入力を促す表示)による区別がないことに注意してください。

,d

",d" コマンドでサイコロを振ることが出来ます。

,d
Console: Send: 1d6 = [4] = 4.
,2d6
Console: Send: 2d6 = [3, 4] = 7.

,quit

",quit" コマンド で Aizunaを終了出来ます。

,quit
Console: Exit

その他のコマンドの詳説はAizuna コマンドを参照してください。