DEVELOPMENT.md

Docuemnts for javabound developers

Note: __unpacked means unpacked assets.

List of objects

Icon	Images	Internal name	Description	Label	Description(ja)	Label(ja)
		java-crafting-station	Java Factory	-	ジャバ工場	-
		javabo	Crimson Javabutton	"Free Java Download"	紅いジャバボタン	"無料ジャバのダウンロード"
		javabo-couch	Loungeable Crimson Javabutton	"Free Java Download"	座れる、紅いジャバボタン	"無料ジャバのダウンロード"
		javabo-blue	Navy Javabutton	TODO: ????	青いジャバボタン	"無料ジャバのダ"
		javabo-couch-blue	Loungeable Navy Javabutton	TODO: ????	座れる、青いジャバボタン	"無料ジャバのダ"
		javabo-block	Stackable ornament. (The prototype of Java Button)	"J"	スタックできるブロックのような置物。 (MOD作成中の産物なので実はオマケ)	"ジ"
		javacopy-java-you	Message A from Java	"JAVA+YOU"	ジャバからのメッセージ A	"あなたとジャバ,"
		javacopy-downloa	Message B from Java	"DOWNLOAD"	ジャバからのメッセージ B	"今すぐダウンロー"
		javacopy-do	Message C from Java	"TODAY!"	メッセージC。 メッセージBの最後が改行される環境を再現するため、独立して用意した。 英語版は、三行目が "TODAY!" となり自然なため、問題ない。	"ド"

Ref. (lang:en)

Ref. (lang:ja)

Rules of filenames

Example:

          [FIXED] Project name
             /
            |                Sub object name     for icon. Ex. {|.icon}
            |________           /___________     /____
 src/objects/javabound/javacopy-downloa-today_ja.icon.png
    ~~~~~~~           ~~~~~~~~               ~~
    /                /                      /
    |                |                     language 
    |                Main object name         Ex. {_js|_en|...}
    |
    One of structure for Starbound.
        Ex. {recipes|items|tiles|...}

Extensions:

• *.frames : JSON. The definitions of sprite.

  if foo.png exists, then need foo.frames.

• *.object : JSON. Metadata. ( Description, Name, category... )

• *.png : Object iamge.

• *.icon.png : Icon for Crafting Table or Inventory or when it's on floorthe .

• *.recipe : JSON. Meta data for crafting. (Ex. 0 money per 1 Java button )

• *.patch : JSON. patch for existing JSON. See RFC 6901.

Note: A rule of *.icon.png is own's one.

Localization

TODO: Add Rules.

Idea 1

javabo_ja.object -> javabo_en.object

About *.frames

• "orientations"
  • "image" : 向きに関わらず、左右反転させないときの画像ファイル指定。(文字があるときに有効)
  • "dualImage" : 向きに応じて、左右反転させる。 (文字が鏡文字になる？)
  • "imageLayers" : レイヤーを多層にするとき。

.animation があるとき、 "image" 指定に関わらず片方が鏡文字になる場合は、 以下のように "direction" を指定するとよいかもしれない。

  "orientations" : [
    {
      (略)
      "direction" : "right",

imageLayers の例:

"fullbright" : true を付加すると、ライティングを無視(?)して表示できる。

下記の例では、 java-crafting-station.png を(ライトを無視して)はっきり表示し、 その上に override する形で java-crafting-station.lit.png を表示している。

一部を目立たせるオブジェクトに使うとよさそうである。

      "imageLayers" : [
        { "image" : "java-crafting-station.png:<color>.<frame>", "fullbright" : true }, 
        { "image" : "java-crafting-station.lit.png:<color>.<frame>" } 
      ],

実際の例: vendingmachine

About interactions

Momentary switch (押しボタン)

at *.object

  "animation" : "/objects/wired/switch/switchtoggle.animation",
  "scripts" : [
    "/objects/wired/momentaryswitch/momentaryswitch.lua",
  ],

  // scriptDelta / 60 * interval 秒間つく
  "scriptDelta" : 5,    // lua内のupdateイベント実行間隔 (tick数)
  "interval" : 15,      // offになるまでのカウント(updateイベントが指定回実行されるとオフになる)

  "outputNodes" : [ [0, 0] ],   // 出力穴を1個 (0,0) の位置に配置

他の .animation と被る場合は、.animation を書き起こす必要があるかも。

Ref:

• __unpacked/objects/wired/momentaryswitch/momentaryswitch.lua

Examples:

• __unpacked/objects/wired/tinywallbutton/tinywallbutton.object
• __unpacked/objects/wired/smallwallbutton/smallwallbutton.object

Switch (切り替えスイッチ)

Persistentswitch は memorize な switch?

Ref:

• __unpacked/objects/wired/switch/persistentswitch.lua
• __unpacked/objects/wired/switch/switch.lua

Examples:

• __unpacked/objects/wired/persistentswitch/persistentswitch.object
• __unpacked/objects/wired/tinywallswitch/tinywallswitch.object
• __unpacked/objects/wired/smallwallswitch/smallwallswitch.object

wiring 組合せ memo

• Small Wall Button + Alert Light : oneshot(momentary) alert.
  • Small Wall Button :
  • Alert Light :
• Small Wall Switch + Alert Light : ON/OFF switch for alert

Making crafting

ref. __unpacked/objects/crafting/*

ref. Existing crafting objects(ver 1.1):

Icon	Image	objectName	Size	frames
		campfire	16x16	4
		woodencookingtable	32x36	1
		craftingfurnace	24x24	4
		craftingfurnace	24x24	4
		pixelcompressor	48x32	8

Directory

• /interface/javabound/*.png: Parts of UI.

*.object template

interactData:

  // (略)
  "interactAction" : "OpenCraftingInterface",
  "interactData" : {
    // Search "crafting.*\.config" ...
    // Ex. crafting.config
    // Ex. craftingmerchant.config
    "config" : "/interface/windowconfig/crafting*****.config",
    
    // Crafting category
    // Ex. "campfire",
    "filter" : [ "*****" ],

    // Override interface
    "paneLayoutOverride" : {
      "windowtitle" : {
        "title" : " *******************",
        "subtitle" : " ***********************************",
        "icon" : {
          "file" : "/interface/javabound/****icon.png"
        }
      }
    }
  },
  // (略)

Sound Effects

• sfx/objects/

  • javabound_java22.ogg (Public Domain)

    From https://github.com/arigato-java/java_sound

  • javabound-download00.ogg (Public Domain)

    Edited from sounds/Dial Up Modem-SoundBible.com-909377495.flac http://soundbible.com/136-Dial-Up-Modem.html

  • javabound_java-server_loop.ogg (Public Domain)

    Contributed by @tomari #18

Objects毎の環境音を設定する方法

例: *.object に以下のように追加すると、サーバーの動作音がなる。 soundEffectRangeMultiplier の調整により、かなり近いたときに音が聞こえる。

  "soundEffect" : "/sfx/objects/javabound_java-server_loop.ogg",
  "soundEffectRangeMultiplier" : 0.5