📘

執筆環境をGitHubで構築する可能性

2023/01/02に公開約1,900字

はじめに

筆者は趣味でTPRGをやっています。
これはドラクエなどのRPGゲームを卓上で行うアナログゲームの一種で、私は自分で作成したシナリオを使って遊ぶこともあります。
ですが、悩みなのは執筆環境をどうするかということです。
ワードやらテキストやら色々と試しましたが、最近githubとエディタを利用した執筆環境の可能性を見出したのでアイデアとしてまとめます。

適宜更新していければ良いな。

やりたいこと

以下はなんとなくあると良いなと常々思っている機能です。

  • テキストが快適に書けること
  • バージョン管理できること
  • 関連するファイルを簡単管理できること
    • シナリオで利用する画像ファイルや音楽ファイルなど、PDFなど
  • メモを残せること
  • 書きかけのシナリオについて後から当時の状況を回想できること
  • 自動校正してくれる(Typoや執筆ルールのチェック)
  • プレイヤーへの配布用にPDFなどの資料への変換が容易であること
  • 他人数でも編集が容易であること

エディタ&GitHubとの親和性

  1. テキストが快適に書ける
    エディタはそもそもプログラミングを行うツールなので、カスタマブルになっていることが執筆においても有用です。
    予測変換やページ内リンクなどWordにもGoogle Docsも必要な機能を持っている自分が使いやすいように改造できるというのは必要な人にとってはありがたい方もいるのではないでしょうか。
    同じ思想の方がいらっしゃったので以下の記事をご覧ください。

https://logmi.jp/tech/articles/325715

  1. 文章校正
    コーディングで用いられるエディタではLint機能を追加することがよくあります。
    textlintなどがそれにあたりますが、これは執筆での校正においても役に立ちます。
    例えば、以下のように小説用のルールを用意してくれている人もいるのでこれを利用すると小説として必要なルールを満たした内容で校正してくれます。
    https://io-monad.hatenablog.com/entry/2016/02/27/153946
    また、表記ゆれについてもチェックできます。
    Proofdictを利用するとシナリオ毎の辞書登録も容易です。
    https://zenn.dev/takasp/articles/0ef1645b118960

  2. PDF化などファイルの変換が容易
    2で書いたことと似ていますが、Pandocやそれに類するソフトをインストールすると快適になります。
    一度仕組みを整えてしまえば、一々PDF化に手間取ることなくファイルを保存したら1コマンドでPDF化できます。
    これはMarkdownやText形式で書いた時に役立つのはもちろん、LaTexRe:viewなどを利用して執筆したとしても同様に変換できるのは大きな点です。
    キャンペーンのシナリオを書くときは大きなボリュームになりがちですから…。
    https://pandoc-doc-ja.readthedocs.io/ja/latest/users-guide.html
    https://shikasen-engineer.com/convert_md_to_docxnpdf_by_pandoc/

  3. バージョン管理を含めて周辺ファイルをまとめて管理できる
    これはGitを利用するメリットの1つです。
    そもそもプログラミングにおいては適切にファイルを整理して管理し、必要な時に必要な状態に戻せることが重要視されていますがこれは執筆においても同じことが言えます。
    どこを/だれが/いつ/どのように編集したかを逐一コメント付きで記録できますので、振り返ったときに編集箇所をすぐに把握できます。
    また下記に示すようにGitHub ProjectやPullReqestも効果的に利用することでさらに便利に使うことができるようになりそうですね。
    ここは私もこれから試してみます。

https://zenn.dev/haoblackj/articles/8cbadb26ca16e4

https://zenn.dev/haoblackj/articles/manuscript_compare_by_pr

また、GitHubPagesを利用すると適当なファイルを元に公開ページを作成できますから、宣伝にも大いに活用できそうですが、まだ具体的なアイデアではないので試行錯誤してみたいです。
ぜひアイデアをいただけると嬉しいです。

Discussion

ログインするとコメントできます