プラグインの作成

Tag: 工事中

　ここではプラグインの作成のしかたについて説明します。プラグインをマスターして好きな建物で町を埋め尽くしてしまいましょう。ここでは家や工場などの作り方を紹介します。
　飛行機や道路などの特殊なものをつくりたい場合は、一度ここに目を通したのちに番外編を見ながら作成してください。

準備する物

最低限必要なものです。

1. jsonファイルを編集できるソフト(スマホ・パソコンどちらも可)
2. 小さな絵(ドット絵)が書けるソフト(スマホ・パソコンどちらも可)
3. ファイルマネージャーのアプリ(スマホ)
4. 少しのプログラミングの理解度

このページを作成したすとらまはwindows10のパソコンで[1]に「visual studio code」を、[2]に「MSペイント」を使用しました。使用機種はアンドロイドです。

theotownのフォーラムによると、絵を書くソフトにはPixlyとNovixがよく使われているみたいです。この２つはスマホアプリです。

ファイルマネージャーのアプリにはCXファイルエクスプローラがおすすめです。このファイルマネージャーはjsonの編集もできるため、かなり汎用性が高いアプリになります。

作り方

いよいよ作成の手順について説明します。手順はすとらまが実際に行ってうまくいった方法について説明するため、使うソフトが違うと手順が多少異なる恐れがあります。

　建物なんてどーでもええんや！飛行機が作りたいんや！って人はこちらへ

その1 絵の作成

まず絵を作成します。建物の大きさそれぞれにテンプレートがあります。ぜひ活用してください。

テンプレート一覧

1×1	2×2	3×3	4×4	5×5	6×6

上下どちらのテンプレを使っても大きさはかわりません。升目があったほうがいいという方は下のをお使いください。

このテンプレートはtheotownのフォーラムから引用したものです。
緑のほうの出典元
灰色のほうの出典元

編集者は古風なポストを作成しました

絵には背景透過が必要です。やり方がわからないという方はpeko stepというところでできるので、使ってみてください。地面を透過してしまうと、地面の部分がなくなり、水に浮いたような状態になってしまいます。


絵の名前はわかりやすい名前にしておきましょう。あとでjsonファイルに入力します。

その2 jsonファイルの作成

プラグインなどユーザーメイドなコンテンツのほとんどで立ちはだかる壁。それのほとんどってプログラムみたいなへんなやつだと思います。ここではできるだけ分かりやすく説明したいと思います。

まずここで編集者の作成したjsonを紹介します。

[{  "id": "Marsneko_post.1a",
"type": "residential",
"width": 1,
"height": 1,
"frames": [ {"bmp": "this_is_post.png"}]
"level": 1 }]

これで最低限です。一行ずつ説明します。

id

プラグイン固有のIDです。これが他と同じものは作ってもアプリを起動するさいに弾かれてしまいます。

"id": "ここにIDを挿入",

type

建物の種類を決めることができます。上にあげた例では、residentialとなっていますが、これは住居になります。

"type": "ここに以下の種類の一覧のなかのどれかを挿入",

width

横の大きさです。1で１マスになります。

"width": ここに数字を挿入,

height

縦の大きさです。基本的にwidthと同じです。

"height": ここに数字を挿入,

frames

テクスチャです。ここにさきほど書いた絵の名前を入力します。

"frames": [ {"bmp": "この範囲に絵の名前を挿入"}]

level

住民のレベルです。1~3まであります。

"level": ここに1~3の数字を挿入

その他

上で紹介した他にもたくさんの項目を付け足すことができます。付け足すことでより詳細に建物の設定をしていくことができます。

その他

その他jsonに挿入できる必須でない項目です。
^がついているものは中身になにも書かれていません。調査中なものです。

author

プラグインを作った人の名前です。編集者は名前のスペルを一度間違えてしまいましたが、間違えても機能します。

"author": "ここに名前を挿入",

title

名前です。

"title":"名前",

名前の部分に文字を入力することで、建物の名前になります。日本語はできません。

ニュートリートメントアイランドという名の家

text

説明文です。

"text":"文章",

文章の部分に文字を入力することで、「i」のボタンを押したときにでてくる説明文になります。しかし、日本語はできません。

訳:これはSM-28 マチェーテです。

smoke

煙を出すことができます。

"smoke": [ {"id": "煙の種類","x": 数字,"y": -数字} ]

• まず煙の種類を決めます。
  
  フォーラムのスクショです。煙は上の画像の中から選びます。
  
  
• 煙がでる場所を決めます。場所はxとyの場所に数字を挿入することで決めることができます。xとyは以下の画像を参考に挿入してください。
  
  緑の点の部分から煙がでるようにします。
  xは横線の長さを示します。この画像の場合は42です。
  yは縦線の長さを示します。この画像の場合は5です。しかし、縦線を挿入するさいは必ず「-」を数字の前に挿入してください。さもないと煙が下からでます

編集者が作成した機関車

煙がでるようになっている。この煙は「$smoke04」の煙。

animation

アニメーションです。

"animation":[ {"id":"1x2l", "x":9, "y":-4}, {"id":"1x2l","x":20, "y":-2}],

現在調査中…

^border frames

^edge frames

^edge border frames

^frames winter

^random frame

preview frames

建物のプレビューです。

"preview frames":[{"bmp":"画像の名前.png"}],

建物のプレビューを設定できるようになります。基本的に大きさの条件等はないものと思われます。400×400まで確認済み

プレビューを設定した様子

実際の建物の見た目に関係なく画像が設定できるようになる。

needs*

設置に関するあれこれです。

"needs road":false,

道路が必要でなくなります。この項目がない場合はtrueなため道路が必要です。

"needs land":false,

水の上に設置できるようになります。しかし地面には設置できなくなります。この項目がない場合はtrueなため地面に設置できます。

"needs water":true,

地面の一部が水でないと設置できなくなります。イメージとしては小さいポンプ場そのもの。2マス以上の大きさでないと意味がない。この項目がない場合はfalseなため、一部水があると設置できません。

build time

建設日数です。

"build time":数字,

建物の設置に数字の日数だけかかるようになります。0でポン置きにできます。

influence *

効果範囲です。
番外編２を参照してください。

provide aspect *

効果人数です。
番外編２を参照してください。

^animated

price

値段です。

"price":数字,

数字の箇所に数字をいれると、その値段になります。この項目がない場合は、ものの大きさなどによって勝手に値段が決まります。

monthly price

維持費です。

"monthly price":数字,

数字の箇所に数字をいれると、月間維持費になり、毎月その値段がひかれます。この項目がない場合は月間維持費はかかりません。

• をつけると月収になりますが、不正防止のためにどんなに数字を大きくしても1Tしか月収を得ることができません。フォーラムにて確認

^power

^water

^max count

draw ground

地面を透過できます。

"draw ground": true,

通常は建物の絵を作成するさい、地面を透過してしまうと、地面がなくなって水になります。しかし、この項目をいれることで地面を透過しても地面が水にならなくなります。

trueの場合	falseの場合

rotation aware

建物の回転ができるようになります。

"rotation aware":true,

この項目がない場合はfalse(だめ)となっているため、回転することはできません。

"frames": [ {"bmp": "絵1.png"},{"bmp": "絵2.png"},{"bmp": "絵3.png"},{"bmp": "絵4.png"} ],

回転させたときに貼られる絵は上のように設定できます。

回転することによって四色になったポスト。矢印で色が変えられるようになった。

^map color

^map color winter

^habitants

^workers

^auto build

^conductive

^super conductive

destroyable

燃えるかどうかです。

"destroyable":false,

falseにすると燃えなくなります。そのため、災害の火事をおこすこともできません。この項目がない場合はtrueなため、燃えます。少なくとも耐火性です

removeable

壊せるかどうかです。

"removeable":false,

falseにすると建物が壊せなくなります。ほんとになにしても壊せなくなります。でも実は隕石をぶつけたら壊せます。この項目がない場合はtrueなため、壊すことができます。

^meta

^fun

^upgrades

^add prices

^supports shoreline

^draw ground water

完成したら

動作の確認をし、ひとつのファイルにしていまいます。

動作確認

まずしっかり機能するか確認するために、ファイルマネージャーでプラグインが適用される場所に作成したファイルどもをコピーしにいきます。

メインストレージ/Android/data/info.flowersoft.theotown.theotown/files/plugins/sample

に作成したjsonと絵を貼り付けます。もとからあったファイルは削除しても問題ありません。

貼り付けたらtheotownを再起動してみましょう。プラグインの項目に作成したものがあったら成功です。

編集者が作成したポスト煙をはいてるけど気にしてはいけない

マニフェストの作成

一つ一つのプラグインを区別するために必要なものです。主に公開するために作成しますが、特にそうする必要性のないものは、これ以降の作業は必要ありません。

編集者が作成したマニフェストです。

{
  "id":"this_is_STAVATTI-plugin",
  "version":1,
  "title":"STAVATTI",
  "author":"Marsneko",
  "thumbnail":"stavatti.png",
}

これで最低限です。一つずつ解説します。

id

idです。

"id":"ここに文字列を挿入",

基本的にjsonの作成の項目にあったものと同じでテキトウなものでもかまいません。

version

バージョンです。

"version":数字,

数字の箇所にプラグインのバージョンを挿入します。しかし毎回変えないとエラーになる訳ではありません。ずっと1でも大丈夫です。

title

タイトルです。

"title":"タイトル名",

ここでタイトル名を指定できます。ひらがななどの日本語にしてしまうとすべて?に置き換えられてしまうため、英数字を使ってください。

author

作者名です。

"author":"名前",

基本的にjsonの作成の項目にあったものと同じです。

thumbnail

サムネイルです。

"thumbnail":"画像名.png",

ここでサムネイルにする画像を指定します。なくても起動しますが、プラグインの項目に表示されなくなるため。必須になります。

その他

その他必須でないものです。

編集者が作成したプラグイン

完成するとこんな感じでサンプルプラグインでなくなります。

プラグインファイルの作成

これまでつくったファイルを一つのファイルにまとめ、公開できるようにします。

1. まず歯車をタップし、コンソールを開きます
   
   この歯車のマークをおす。町からでも地域からどちらも可
   
   一番下のコンソールを開く
   
   コンソールの画面
   
   
2. コンソールに文字を入力します。

   export:{dir:"フォルダ名"}

   とコンソールに入力し、実行します。フォルダ名の箇所は作成したファイルどもが入っているフォルダ名にしてください。
   
   
3. filesにファイルが作成されます。
   「フォルダ名.plugin」というファイルが作成されていたら成功です。公開するさいはこのファイルを添付してください。

コメント

紹介用コメント欄

&attachref(ファイル,nolink,);

通常コメント欄

こちらには情報提供とか感想や質問などをお願いします。