Skip to content

GitHub/FTPの運用

SORCERIAN Next edited this page Feb 22, 2020 · 38 revisions

アップロードルール

共通

  • 当面はGitHub/FTP共に、更新時にDなどでお声がけください(GitHubは履歴が残るので、慣れてきたらルール変更しますが、当面はトラブル防止のため、念のため)
  • いずれの環境も容量が少ないため、大容量のファイルUpは避けてください(いずれの環境もマスター/本番環境なので、バックアップ、作業/一時ファイル、テストファイルなどは小サイズでもお避け下さい。ストレージ用途はあくまでOneDriveで)
  • SText本体の動作に支障をきたす可能性があるので、「更新可能なファイル」(後述)以外の変更はお避け下さい。
  • 新規のシナリオフォルダーをUpする場合には、事前にご要望のシナリオidをお教えください(ほぼ大丈夫だと思いますが、将来的に想定しているフォルダーとのバッティングを避けるため)。
  • 基本、GitHub(開発環境)→FTP(本番環境)の順序で更新願います(ただし、stext.xmlなどサイトの見え方を確認しながら短時間に何度も更新する場合は、例外的には逆もあり)。

GitHub

開発環境です(開発時もこちらを参照しています)

  • 更新可能なファイルは、/stext フォルダー(https://github.com/snext1220/stext/tree/master/stext )配下の自シナフォルダー配下、及び、stext.xml(後述)のみと致します。
  • シナリオフォルダーを変更した場合、即座に本番環境に反映させるかどうかは事前テストの要否によってご判断ください(本番環境での直接テストでも十分な場合はそのままFTPに挙げて戴いて構いません)。もしFTPへのUpを保留する場合も、1~2Wのラグで同期するようにしてください(両者が長期間にわたって異なる状態であるのは避けたい)。
  • stext.xmlを編集した場合には、即座にFTPにもUploadをお願いいたします(競合リスクがあるので、保留はしない)。
  • 将来的には、作成戴いた画像などのUpも直接お願いするかも(主に、ときのじさんへ)
  • ここで更新した内容はGitHub Page(https://snext1220.github.io/stext/ )に反映されます。ただし、若干のタイムラグがある感じ?
  • GitHub上で新規にフォルダーを作成するには、若干特殊な操作が必要になります。以下参考にしてください(http://maeokaka.hatenablog.jp/entry/2016/07/07/001441
    • 一旦はダミーファイルを作成しなければなりませんが、その場合、作業後、削除をお願いします。
  • すべての履歴が残るため、履歴の嵐にならぬよう、(もし行う場合も)アップロード等のテストは最小限にお願いいたします。
  • 同じく履歴の嵐を避けるため、同種の修正を何度もUpするのは避けてください(誤字修正など。手元、Playgroundで確認してからのUpをご協力願います)。

FTP

本番環境です。web-deli.comにそのまま反映されるので、シナリオ更新は十分なテストの上でお願いします。

  • 更新可能なファイルは、自シナフォルダー配下、及び、stext.xmlのみと致します。
  • その他はGitHub側で触れているので割愛します。

stext.xml

シナリオの基本情報を表すデータで、STextページ(stext.aspx)の表示はここでの情報を利用しています。シナリオの新規登録&更新時は、適宜各位で更新願います。ファイルの破損によって、STextページが正しく表示されなくなる可能性があるので注意してください。

以下は、stext.xmlの構造です。

  • stext ルート要素
    • scenario シナリオデータを束ねる要素
      • work 個々のシナリオ情報(複数列挙可。★の属性はscenario配下でのみ利用可)
        • @id シナリオid(未公開時は任意)
        • @title シナリオのタイトル
        • @author 著者名
        • @series:シリーズ名(ドラゴンモード Vol.1など。ある場合だけ)★
        • @tags:分類(戦国、ダークファンタジー、ギャグ、日常、リメイクなど。複数可)★
        • @published:公開日(「2018-01-05」の形式)★
        • @updated:最終更新日(「2018-01-05」の形式)
        • @level:難易度(5段階) ★
        • @scenes:シーン数★
        • @results:実績数★
        • @clears:クリアと見なす実績id(カンマ区切りで複数可)★
        • @comment:著者からのコメント(50~80文字程度)★
        • @guest ゲストの著者か(現在は未使用。将来は表記の制御に利用するかも)
        • @quest アンケートid(Googleフォームの埋め込みURLのid)
        • @unpublished 未公開か(futureから移動時も消さない。公開時は属性そのものを削除)◆将来削除予定◆
        • #text 紹介文(基本、Markdown形式ですが、画像埋め込み、赤字などはHTMLでの記載が必要)
    • utility ユーティリティのデータを束ねる要素
      • work 個々のユーティリティ情報(利用できる属性等はシナリオのものに準ずる。以下、utility固有の説明)
        • @id Util 5のようにシナリオ扱いのものを除いては不要
        • @type 種別(dev、usr、both)
        • @backup バックアップ機能にリストアップするもの(値は固定でtrue)
    • future まだタイトルのみのシナリオ情報(今後のリリース予定に表示。紹介文入ったものは、scenario配下へ移動)
      • work 個々のシナリオ情報(利用できる属性等はシナリオのものに準ずる。以下、future固有の説明)
        • @title、@author これらのみ必須(仮でも構いません)
        • @unpublished 完成予定月を「2018年12月」の形式で入力。未定の場合は省略可
        • #text 紹介文は入れても構わないが、基本、入れたものはscenario配下に移動のこと(それによって「リリース予定」からシナリオ一覧に移動)

#textへの赤字埋め込みには、<p class="award">を利用してください。

シナリオ公開準備時のstext.xml編集例

<work id="シナリオid(innなど)" title="シナリオ名" author="作者名"
  guest="true(※外部投稿者様のシナリオの場合に設定。スタッフのシナリオでは設定しない"
  unpublished="true(※シナ未公開時のみ設定。『冒険に出発する』非表示。公開時un~"true"まで全削除)
  series="ミニミニ30祭(などの参加シリーズ名。なければ""のままで)"
  tags="探索,ミニゲーム(シナリオのジャンル。複数ある場合は『,』で区切る)"
  published="20XX-01-01(シナリオ公開日)" updated="20XX-02-01(シナリオ更新日)"
  level="2(1~5のいずれか)" scenes="30(シナリオのSceneの数。パラグラフ)"
  results="10(シナリオの実績数)" clears="r20(シナリオをクリアしたと判定する実績の設定)"
  comment="ミニミニ30祭のシナリオに挑戦してみました。みんな、読んでね!(作者コメント)">
<img src="./stext/シナリオid(innなど)/capture/intro.png(紹介画像。idだけ変更する)"
  height="120(※ここは変更しない)"
  title="シナリオ名" align="right(またはleft。紹介画像と紹介文が右寄せか左寄せか)"
  class="right(またはleft。紹介画像と紹介文が右寄せか左寄せか)" />
<p class="award">ミニミニ30祭Vol.20 (30Scene限定シナリオ)(シナリオのナンバー&シリーズ名)</p>

シナリオ紹介文
(大体250文字くらいの長さでお願いします。適度に改行も可)

<p class="award">20XX年12月20日公開予定です(※シナリオ公開前に記入。公開後に削除)</p>
</work>

quest属性について(アンケートフォーム)

アンケートフォームはGoogleフォームの機能を利用しています。 それぞれのGoogleアカウントで作成し、idのみをstext.xmlに紐づけてください。 基本的な使い方は、以下のページを参照のこと。

https://prebell.so-net.ne.jp/tips/pre_19060401.html

アンケート作成時のルールは以下の最低限に留めます(問題が出てきたら都度検討)

  • アンケートタイトル:シナリオ名
  • リード文:プレイされた方は、宜しければアンケートに是非ご協力ください。今後の制作の参考にさせて戴きます。=> こちらも参考文なので、異なる文章でも可
  • サイズ設定:特になし => サイト側で自動設定されます
  • その他設定:シナ作者さんにてご自由に

【懸案】共有設定することで、他の人が作成したアンケートも参照できるようになります。回答共有の用途スタッフ間のみ共有設定します、か?

id値は、[送信]ボタンからリンクを共有すると、以下のようなURLが表示されます。★~★の部分がid値となります。

https://docs.google.com/forms/d/e/★1FAIpQLSfAL7gm-WCdtzXygPUU6BgIBH2dBEYhEw8zt49VPciqYRpmSg★/viewform?usp=sf_link