Readme の書き方 のバックアップ(No.11)

　このページはゲーム制作上におけるReadme作成の負担軽減を目的としています。
作品や素材情報の記述方法に関するノウハウをまとめてます。
※ここでは、ゲーム及び素材製作者向けの解説を行う。
執筆中項目多数

　Readmeの意義 †

リードミー(Readme)とは、ソフトウェアなどの配布物に添付されている添付文章のことである。
最初に読むべきものとされており、重要な情報が記載されている。
  • 　Readmeは、ゲームや素材を配布する際には、必ず添付するべき物である。
    何故ならReadmeは、製作者情報、バージョン情報、使用素材の著作権情報、利用規約などといった情報を記載するものであり、
    存在しない場合は製作者やバージョン情報などが不明となる可能性が高いからである。
    　また、使用素材の著作権情報も記載せねばならない場合が多く、
    Readmeが存在しない場合、著作権侵害に該当する可能性もある。
    スタッフロールなどでゲーム内に記載しても良いが、
    Readmeに著作権情報を記載するよう利用規約に定めている素材も多いので、止めておいた方が良い。
    あくまでスタッフロールは演出と考えるべきである。

　以下◆＝作品、◇＝素材

↑

　Readmeの内容 †

　以下◆＝作品、◇＝素材

↑

　必須項目 †

　印刷物で優先的に記載したい項目
　WebサイトやReadme等他の媒体のでも同じく優先事項

↑

　作品名（タイトル）と見出し　◆　◇ †

  • 　ソフト名と簡単なバージョン情報(Ver〇〇)や動作環境(For〇〇)等
↑

　製作者の連絡先　(配布元)　◆　◇　 †

  • 連絡先も必要である。バグが存在した場合に連絡が取れないと、バグ報告ができない上、信用性に関わる。
    　連絡先は連絡が取れるものであれば何でも良い。メールアドレスでも良いし、HPやブログのURL。掲示板でも良い(ただし、製作者が管理をしている物を強く推奨する)。
↑

　動作環境　◆ †

  • 　ここに記載されている環境以外では動作を保障しないことを意味し、免責・保証事項と類似。 　ウディタ本体Verにより変化、詳しくは制作したマニュアル参照

　■　動作OS ： Windows〇〇

　■　PC(マシン)スペック：CPU 〇〇以上、メモリ〇〇以上
　(開発したゲームの処理量・解像度に応じて大幅に変化。)

　■　必要ランタイム ： DirectX 〇以上

　■　その他の動作環境に依存する不具合 　　

↑

　価格・種別 　◆　◇ †

↑

　著作権表示　◆　◇ †

  • 間違っても絶対に忘れてはならない項目である。素材配布は、利用者が著作権侵害を行わないという信頼の元に成り立っている。その信頼性が崩れれば素材配布をする者がいなくなってしまうので、絶対に厳守する事。最悪の場合、使用料や損害賠償を請求されるので、絶対に守るように。
    　著作権表示は、素材の利用規約で指定された通りに表記しなければならない。
    特別指定されていなければ、「製作者名」、「素材配布されているサイトの名前」、「サイトのトップページのURL」の以上三点を記載すれば問題無いであろう。URLはトップページ以外の物だと、アドレスが変わってしまう場合があるので止めておいた方が良い。
  • 　たまに、素材の著作権表示がReadmeとは別のファイルに記述されていることがあるが、これは止めておいた方が良い。
↑

　利用規約　◆　◇ †

  • 　自意識過剰な人に見られるけど社交辞令みたいなものだと思って下さい

　　　　　■■■■■　作品配布の際の利用規約の書き方　■■■■■

  • 　作品内の素材を抜き出して配布するのは禁止しますとか、
    個人間のうんたらかんたらとか、
    雑誌やWebサイト上に掲載する時はどうたらこうたらとか、
    色んな事を考慮した意思表示

　　　　　■■■■■　素材配布の際の利用規約の書き方　■■■■■

  • 　素材を自由に使って良いとするにしても、その旨を書いたほうが良い。
    何故なら、これが配布者の意思であると利用者に伝えることになるからである。
    　では、定める際はどのような事を書けば良いのか。
    基本的には、配布者が素材を利用する者に要望したいことを書けばよい。
    これならしても良い、これは行っては駄目、という風にである。
  • 　なにか参考が欲しければ、他の配布者の利用規約を読んでみてもよいし、
    クリエイティブ・コモンズ・ライセンスのような、著作権のライセンスを参考にする、或いは利用するのも手である。
    ちなみに、この公式Wikiの利用条件基本ルールにのっとった素材は、素材単体の商用販売は禁止されているので気を付けて下さい。
↑

　準必須項目 †

  • 　readmeや作中、Webサイト等で優先的に記載したい項目
    　印刷物には記載しなくても問題ありません（取扱説明書除く）
↑

　製作者名 （クレジット）　◆　◇ †

  • 　製作者名は必ず記載する必要がある。記載されていないとゲーム自体の信用性に関わるからだ。最悪の場合、ウィルスやスパイソフトと勘違いされてしまう可能性がある。 　製作者名の書き方は自由である。本名でも良いし、ハンドルネームでも良い。
    　共同制作者・サークル(デバッガーやテスター含む)や素材提供者などもスタッフロールで表記しておくとよいでしょう。
    　また、質問に対して回答してくれた人や参考になった講座サイトの場合は、スペシャルサンクスとして記載しておくと印象は良くなります。
↑

　インストール　◆ †

  • 　ウディタの場合、インストール不要なので忘れがちですが、知らない人からすればかなり敬遠されます。
    インストール過程は無いと記述した方がいいです。
    また何らかの趣向(コンバートやパッチ等)を凝らし、起動までに何らかの過程を挟む場合は注意を払った方がいいでしょう。
↑

　アンインストール　◆ †

  • 　解凍して作成されたフォルダ・ファイルを削除すればＯＫという具合です。
↑

　プロバディ・コンフィング設定　◆ †

  • 　動作(BGMや描画)の設定方法について。ゲーム中にコンフィング機能を自作している場合は別途記述
↑

　起動方法　（始め方）　◆ †

  • 　以下転載(コピペ)でOK
       Game.exe(赤い狼のアイコン)を選択・ダブルクリック
↑

　操作方法(遊び方)　◆ †

  • 　基本システムを使用した場合はぴぽさんが配布しているテンプレのがおススメです。
↑

　終了方法　(終わり方)　◆ †

  • 　操作方法にまとめて記述することでOK
↑

　導入方法(組み方)　◇ †

  • 　特にコモンイベントの場合は重要
↑

　同梱データ・ファイル構成一覧　◆　◇ †

  • 　何らかの事故(例えばデータ破損や同根のし忘れ)が起きた場合、相手側の状況確認をしてもらうのに便利
    ・コンフィング(Confing、アプリケーション)　
    ・Deatフォルダ(暗号化している場合はData.wolf)　
    ・Game.dat、DATファイル　
    ・ウディタ本体ゲーム部(Game.exe,アプリケーション)　
    ・Game、構成設定
    ・GuruguruSMF4.dll、アプリケーション拡張(ウディタ本体Ver1.31以降)
    ・Guruguru.dll、アプリケーション拡張　
    ・Readme　 　他よくある質問は個別にファイルを用意した方がいいです
    　作者HPへのショートカットもあると便利
    　
↑

　バージョン情報（更新履歴・公開日）　◆　◇ †

  • ゲームならば必ず記載すべき物である。バージョン情報を載せることにより、利用者が更新前と何が違うのかや、現在のバージョンが何なのかが理解できる。
    　バージョン情報の書き方は自由である。
    一般的には「Ver1.0」といった書き方をする。桁数は自由だが、頻繁に更新しないのであれば下一桁で十分である。(バージョンアップは別として、そもそも頻繁に更新する事があってはならないであろう)
    初期バージョンは1.0から始める場合が多く、1の桁はバージョンを、小数点以下は更新回数を表す場合もある。また16進法で表記する場合もあるが、これは極めて稀であり、一般的ではないので止めておいた方が良い。
    更新した場合、更新内容をバージョンの後に書いたほうが良い。
    更新内容を書くことにより、利用者が前回との違いやバグ修正内容を理解することが出来る。
↑

　よくある質問　◆　◇ †

  • 　自作システムで特殊な設定・操作方法などの場合に需要があります。
    別ファイル推奨
↑

　推奨項目 †

  • 　印刷物で余裕があれば記載したい項目
    　WebサイトやReadme等他の媒体のでも同じ
    　作品登録する場合、大抵項目が用意されている
↑

　概要　◆　◇ †

  • 　世界観や人物紹介など
↑

　対象年齢・対象者　◆　◇ †

  • 　配布・公開場所の特徴を考えて下さい。
    　また、18禁の場合は必ず記載していただくようお願いします。
↑

　ジャンル　◆ †

  • 　基本システムならRPG
↑

　プレイ時間　◆ †

  • 　およその目安 ２時間程度なら短編 ３〜６時間程度なら中編 ７時間以上で長編
↑

　免責・保証事項　◆　◇ †

  • 　プレイヤー側の過失で事故・賠償責任などが発生しても、
    作者はその責を負いませんとか、
    いかなる環境でも動作することを保障していることではありません的なことを記載
↑

　準推奨項目 †

  • 　余裕があれば
↑

　サムネイル・スクリーンショット(SS)　◆　◇ †

  • 　Readmeの場合、HTMLマニュアル作成ソフトを使用することで可能だけど、基本データ量が重くなり配布する上では不都合。本格的に作り込みたい人向け。
    　メモ帳などtxt形式を使用する場合は、画像ファイルを別途同梱することで可能
↑

　はじめに　◆　◇ †

  • 　第一印象(？)になります、適当な社交辞令でOKです。
↑

　目次　◆　◇ †

  • 　Readmeの内容紹介
↑

　開発環境　◆　◇ †

  • 　主に制作者の動作環境について、バグ報告の時に重要
↑

　制作ツール・開発言語　◆　◇ †

  • 　開発言語はウディタ本体を指します。記載義務はありません
    　素材を自作した場合、著作権の記載が条件の場合は必ず記載すること
    例)　
    　　　製作ツール　
    　WOLF RPGエディターVer〇〇　
    　http://www.silversecond.com/WolfRPGEditor/
↑

　利用ライブラリ著作権表記　◆ †

  • 　以下転載(コピペ)でOK　
     　　　利用ライブラリ著作権表記
 ・DXライブラリ  
 　DX Library Copyright (C) 2001-2005 Takumi Yamada.  
 ・JPEG読み込み機能  
 　libjpeg　Copyright (C) 1991-1998, Thomas G. Lane.　  
 ・Png読み込み機能　    
 　libpng　Copyright (c) 1998-2004 Glenn Randers-Pehrson.　  
 　zlib　Copyright (C) 1995-2004 Jean-loup Gailly and Mark Adler.　  
 ・OggVorbis 読み込み機能　  
 　ogg_static, vorbis_static, vorbisfile_static　  
 　Copyright (C) 1994-2002 XIPHOPHORUS Company.　
↑

　欲しいコメント　◆　◇ †

  • 　報告者側が善意でコメントしても、制作者側には好まれない場合があります。
    　その作者が完成度を追求しているのか、適当な付き合いで公開しているのかで求められる内容も異なります。
    　また、これをプレイヤーに義務化することは、代価行為を要求することになり、強制しない方がいいでしょう。

■バグ報告
　誤字脱字やマップチップの配置ミスも含みます。
　基本的に発見したら報告するのが当たり前ですが、作者側が対応できない(する気が無い)のであれば、その旨を記載しておいた方がいいです。

↑

　謝辞　◆　◇ †

  • 　例えば利用規約に使用報告不要と記載されている素材を報告無しで使った場合など。
↑

　その他注意事項　◆　◇ †

例)　この作品はフィクションです。実在する人物・団体とは一切関係ありません。

↑

　おわりに　◆　◇ †

  • 　はじめに同様適当な社交辞令でOK、あった方が丁寧な印象を与えます。
    　作中ED後が一般的
↑

　Readmeの媒体 †

↑

　同梱テキストファイルの場合 †

　当ページはこちら中心に述べています

↑

　ファイル名 †

  • 　実は、ファイル名に決まりはない。「Readme」というのも、英語で「読んでね」という意味である。日本人向けのゲーム(素材)ならば、日本語で書いても良い。最も重要なことは、最初に読んでもらう事であーる。
↑

　ファイル形式 †

  • 　RPGエディターはWindows環境でのみ動作するソフトなので、Windowsで開くことが出来るファイル形式である必要がある。ただし、特定のソフトウェアでなければ開くことが出来ないファイル形式はNGであーる。
    故に、txt(テキストファイル)やrtf(リッチテキストフォーマット)形式が良い。HTML形式でも良い。
    docx(Wordのドキュメント形式)やodt(OpenOffice?のドキュメント形式)でも、ワードパットで開けるので良いが、
    ワードパットで開けることを知っている人は少なく、またワードパッドではテキスト形式で表示されるため、ワードパッドで使用できない機能が使われていた場合、通常テキストで表示、又は表示自体が行われない。
    その為、推奨は出来ない。
  • 　HTML形式の場合、Readmeと説明書が一緒になっている事がほとんどである。これは有りと言える。
↑

　特記事項 †

  • 一つのファイルに無理矢理まとめる必要はないので、Readmeフォルダを作り目的別(操作方法、よくある質問、権利表記など)にまとめれば画像ファイルの同梱も可能。
↑

　配布物内の場合 †

  • 　スタッフロールやチュートリアル等
↑

　イベントタイプ †

・チュートリアル
・スタッフロール
・クリア後の作者コメント
・タイトルやロゴ
・基本システム『相談』
・図鑑型ヘルプ

↑

　イベント形式　 †

  • 基本的にコモンイベント
↑

　特記事項 †

・基本システム　コモンイベント80　基本ｼｽﾃﾑ説明書も参考になります。　

↑

　Webサイト上の場合 †

  • 　ホームページや作品登録欄など
↑

　ページ名 †

↑

　タイプ †

・登録
公式や委託
・アップローダー
・Wiki
・ブログやtwitter等
・BBS、掲示板など
作品の宣伝を伴う行為になるので、場合によっては悪印象を周囲に与える可能性があります。 そのスレッドのルールに書き込まれていなくても、慣習的に暗黙の了解で避けられいる場合もあるので、宣伝ＯＫのような場所に限った方がいいでしょう。

↑

　特記事項 †

  • 　制約が無い分ダラダラと長文になるかもしれないので、閲覧者が疲れ無いような工夫も必要
    　サイトへのショートカットを同梱することで、Readmeの代用可能
↑

　印刷物の場合 †

　

↑

　印刷物名 †

↑

　印刷物タイプ †

  • ・パッケージ、ジャケット
    ・チラシ、ポスター
    ・カタログ
↑

　特記事項 †

  • ・不特定多数に配布する場合、記載スペースが限られるので要点をまとめる
↑

　関連項目 †

↑

　外部リンク †

↑

このページに関するコメント †

このページに関するコメントがございましたらこちらへどうぞ。

【注意！】
疑問・質問・相談・要望などへの回答は期待しないでください。
また、コメントへの回答・指摘される方は冷静に余裕を持ってお願いします。
  • 相談用掲示板で欲しい記事に書かれていたので、書いてみました。異論があったらバンバン改変しちゃてください。 -- 青山? 2010-12-20 (月) 09:25:46
  • マヌケな感じになったけど、こっちの方がユーモアがあってとっつきやすいと思う。 -- 2010-12-21 (火) 01:16:16
  • Ｒｅａｄｍｅ作成ソフトがあるけど、他人の素材を使用した場合に対応していないから、そこら辺を重点的に改変していきます。 -- 2010-12-21 (火) 01:23:35
  • 青山さん執筆ありがとうございます。順番が狂いました。 -- 2010-12-21 (火) 01:25:03
  • ぴぽさんのはじめてのウディタでゲーム作品用テンプレ配布されていますので、そちらもどうぞ。 -- 2010-12-26 (日) 14:36:55
  • 言葉遣いが一番ネックになってます。キャラを濃くするかべきか丁寧語にして薄くするべきか -- 2011-01-02 (日) 19:32:59
  • この項目については独断と偏見が許されないので、出来るでけ時間をかけて色々な人の意見を取り込みたいと思います。とりあえず項目作成中心。 -- 2011-01-08 (土) 18:48:43