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

リードミー(Readme)とは、ソフトウェアなどの配布物に添付されている添付文章のことである。
最初に読むべきものとされており、重要な情報が記載されている。

※ここでは、ゲーム及び素材製作者向けの解説を行う。

Readmeは、ゲームや素材を配布する際には、必ず添付するべき物である。 何故ならReadmeは、製作者情報、バージョン情報、使用素材の著作権情報、利用規約などといった情報を記載するものであり、 存在しない場合は製作者やバージョン情報などが不明となる可能性が高いからである。

また、使用素材の著作権情報も記載せねばならない場合が多く、 Readmeが存在しない場合、著作権侵害に該当する可能性もある。 スタッフロールなどでゲーム内に記載しても良いが、 Readmeに著作権情報を記載するよう利用規約に定めている素材も多いので、止めておいた方が良い。 あくまでスタッフロールは演出と考えるべきである。

Readmeに記載するべき情報 †

必ず記載すべき情報は以下の通りである。

  • 製作者名
    • 製作者名は必ず記載する必要がある。記載されていないとゲーム自体の信用性に関わるからだ。最悪の場合、ウィルスやスパイソフトと勘違いされてしまう可能性がある。
  • 製作者の連絡先
    • 連絡先も必要である。バグが存在した場合に連絡が取れないと、バグ報告ができない上、上記同様、信用性に関わる。
  • 使用素材の著作権情報
    • 間違っても絶対に忘れてはならない項目である。素材配布は、利用者が著作権侵害を行わないという信頼の元に成り立っている。その信頼性が崩れれば素材配布をする者がいなくなってしまうので、絶対に厳守する事。最悪の場合、使用料や損害賠償を請求されるので、絶対に守るように。
  • バージョン情報
    • ゲームならば必ず記載すべき物である。バージョン情報を載せることにより、利用者が更新前と何が違うのかや、現在のバージョンが何なのかが理解できる。
↑

その他 †

その他には、ゲームの操作説明やストーリーの概要などを記載しても良い。 必要最低限記載すべき物が記載されていれば、あとは何を記載しても良いのである。

↑

Readmeの書き方 †

↑

ファイル名 †

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

↑

ファイル形式 †

RPGエディターはWindows環境でのみ動作するソフトなので、Windowsで開くことが出来るファイル形式である必要がある。ただし、特定のソフトウェアでなければ開くことが出来ないファイル形式はNGである。 故に、txt(テキストファイル)やrtf(リッチテキストフォーマット)形式が良い。HTML形式でも良い。

docx(Wordのドキュメント形式)やodt(OpenOffice?のドキュメント形式)でも、ワードパットで開けるので良いが、 ワードパットで開けることを知っている人は少なく、またワードパッドではテキスト形式で表示されるため、ワードパッドで使用できない機能が使われていた場合、通常テキストで表示、又は表示自体が行われない。 その為、推奨は出来ない。

  • HTML形式の場合、Readmeと説明書が一緒になっている事がほとんどである。これは有りと言える。
↑

製作者名 †

製作者名の書き方は自由である。本名でも良いし、ハンドルネームでも良い。

↑

製作者の連絡先 †

連絡先は連絡が取れるものであれば何でも良い。メールアドレスでも良いし、HPやブログのURL。掲示板でも良い(ただし、製作者が管理をしている物を強く推奨する)。

↑

素材の著作権表示 †

著作権表示は、素材の利用規約で指定された通りに表記しなければならない。 特別指定されていなければ、「製作者名」、「素材配布されているサイトの名前」、「サイトのトップページのURL」の以上三点を記載すれば問題無いであろう。URLはトップページ以外の物だと、アドレスが変わってしまう場合があるので止めておいた方が良い。

  • たまに、素材の著作権表示がReadmeとは別のファイルに記述されていることがあるが、これは止めておいた方が良い。
↑

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

素材配布の際は利用規約を定めた方が良い。 素材を自由に使って良いとするにしても、その旨を書いたほうが良い。 何故なら、これが配布者の意思であると利用者に伝えることになるからである。

では、定める際はどのような事を書けば良いのか。 基本的には、配布者が素材を利用する者に要望したいことを書けばよい。 これならしても良い、これは行っては駄目、という風にである。

なにか参考が欲しければ、他の配布者の利用規約を読んでみてもよいし、 クリエイティブ・コモンズ・ライセンスのような、著作権のライセンスを参考にする、或いは利用するのも手である。

↑

バージョン情報 †

バージョン情報の書き方は自由である。 一般的には「Vr1.0」といった書き方をする。桁数は自由だが、頻繁に更新しないのであれば下一桁で十分である。(バージョンアップは別として、そもそも頻繁に更新する事があってはならないであろう)

初期バージョンは1.0から始める場合が多く、1の桁はバージョンを、小数点以下は更新回数を表す場合もある。また16進法で表記する場合もあるが、これは極めて稀であり、一般的ではないので止めておいた方が良い。

更新した場合、更新内容をバージョンの後に書いたほうが良い。 更新内容を書くことにより、利用者が前回との違いやバグ修正内容を理解することが出来る。

↑

このページに関するQ＆A †

このページに関する疑問等ございましたらこちらへどうぞ。 回答は期待しないでください。

  • 相談用掲示板で欲しい記事に書かれていたので、書いてみました。異論があったらバンバン改変しちゃてください。 -- 青山? 2010-12-20 (月) 09:25:46