TileD VisuStella MZ

From Yanfly.moe Wiki
Revision as of 03:31, 1 August 2022 by Archeia (talk | contribs) (Frequently Asked Questions)
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



Download

System

This is a plugin created for RPG Maker MZ.

InstallPluginsMz.png

UpdatePlugins.png

Troubleshooting.jpg

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.

Click here to learn how to update plugins.

Click here for how to troubleshoot plugins if you get an error.


Masterarbeit Writer


TileD.png


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.

Click here if you want to help support VisuStella on Patreon.

Introduction

Tired of RPG Maker MZ's Map Editor? Do you want to map the XP way but more? Tired of Parallax Mapping? Want to do round corners? Want to create a map with basically unlimited layers?

Well, now all those worries are gone! Instead, let's just use the awesome map editor, TileD! Free, easy to use and very flexible Map Editor. Grab it from here: http://www.mapeditor.org/

Features include all (but not limited to) the following:

  • Any tile size maps!
  • Any number of layers!
  • Manual collision layers!
  • ...More

A warning: This plugin is for advanced users, or users who plan to learn TileD. We at VisuMZ are not TileD support and will not be teaching TileD, or answering support questions in regards to TileD itself.

Frequently Asked Questions

Question: How do I use the Tiled Plugin / How can I make a Tiled Map.

  • Please check the sample projects and open the sample maps. There's documentation in them and a template to help you get started immediately.

Question: My Tiles are not displaying!

  • Make sure to check the sample project folder and see how we set up everything.
  • Make sure that your tilesets are 1024x1024 MAX
  • Make sure that your tilesheet images are in img/tilesets folder as usual.
  • Make sure that your Tiled Maps and Tileset files are .json and in the maps folder.
  • You can only have 12-13 sheets MAX in a single map before RPG Maker starts choking on itself.

Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.


Tier 5

This plugin is a Tier 5 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5).

This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.


Major Changes

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

TileD Mapping

Maps can now be made via the mapping program TileD. This allows you the user to create maps with any number of layers using any tile sized desired. Please see the dedicated sections for more information.

---

Setting up

TileD Maps and Tilesets are stored in the YOUR_PROJECT_FOLDER/Maps folder. This folder does not exists by default, so you will need to create it.

This plugin comes with a few Map and Tileset Templates. The Tileset Templates contain tilesets with predefined Collision, Region, and Flag tiles. You may use these tilesets or create your own for use within your maps.

Maps and Tilesets from TileD are exported as JSON and put in here with the format of MapXXX.json where XXX is the ID of the map, for map files.

Special Layers

This plugin uses special layers to specify certain properties.

---

Region Layer

This is a layer with the property regionId. You can have any number of these layers.

If this layer has a number value (e.g: 2) that means no matter what tile you draw on this layer those tiles will have that speified regionId.

If this layer has the value of tile-base that means the individual tiles will check for a property called regionId to specify that tiles region. See the Special Tilesets section for more information.

---

Collision Layer

This is a layer with the property collision. You can have any number of these layers. They dictate where the player and other entites can move to.

If this layer has a value of tile-base than the collision for this layer is based on the tiles painted. See the special tilesets section for more info.

Other valid values are as followed:

full - Any area of this layer cannot be walked upon from any direction.

up-left - Any area of this layer can only be walked upon from the bottom or right.

up-right - Any area of this layer can only be walked upon from the bottom or left.

down-left - Any area of this layer can be walked upon from the top or right.

down-right - Any area of this layer can only be walked upon from top or left.

---

Reflection Layer

This is a special object layer with the property reflectionCast. Objects on this layer will reflect the character sprites either above or below the character's position on the Y axis based on the value. Negative values will reflect the character that many tiles away above the character, and positive values will reflect the character that many tiles away below the character. Players must enter the objects bounds for reflection to occur.

---

Mirror Layer

This is a special object layer similar to the Reflection Layer with a bit more control. This is an object layer defined by having the property mirrorCast this property doesn't need a value, it need only exists. Mirroring is controlled by the objects on this layers properties. Objects on the layer with the property mirror will utilize a string value of x,y coordinates. (e.g: mirror: 0,1) These coordinates are the offset for where to cast the mirrored sprites image. Mirrored sprites will also mirror the characters up and down directions, so if the character is facing up the mirrored sprite will utilize the down facing sprite and vice versa.

Additional Layer Properties

These properties provide additional layer functionality.

---

zIndex

This property specifies the draw order of the layer. A higher value means it is higher in the order.

---

priority

This property specifies the draw order for the layer when it shares a zIndex.

---

level

This property specifies the level that this layer is on for multi-level maps.

---

hideOnLevel

This property specifies that this layer will be hidden if the player is on the specified level. (e.g: if this has a value of 1, and the player is on a spot with level set to 1, this layer is hidden). If a spot has multiple levels assigned to it, it will fallback to the one with higher priority.

---

Special Tilesets

This plugin uses specialized tilesets with special properties attached to their tiles to handle things such as collision, region id's, and tile flags. below is an explanation of each of these tilesets and how to set them up.

---

Region Tileset

This is a tileset where each tile has a custom property called regionId the value of this property is a number specifiying this tiles region. draw with this tileset on a layer with the property regionId with a value of tile-base for that position on the map to have that tiles region ID.

---

Collision Tileset

This is a tileset where each tile has a custom property defining their collision value for use with tile-base collision layers.

The tiles have a property the option to have the following properties.

collision - Same as the property on layers.

arrowImpassable - This property specifies that the directions given in the string cannot be passed through. It is formated as:

direction1 & direction2 & direction3

e.g: down & left & right This example dictates that the only direction the player can move from this tile is up.

---

Flag Tilesets

This is a tileset that has tiles that specify the special RPG Maker flags. These tiles have any of the following properties.

ladder - This tile acts as a ladder.

damage - This tile is a damage tile

bush - This tile acts as a bush.

counter - This tile acts as a counter

---


Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com.

2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella".

3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code.

4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.

5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code.

6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.

7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.

8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed.

Terms of Use: Japanese


『VisuStella MZ』利用規約

1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。

2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。

3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。

Credits

If you are using this plugin, credit the following people in your game:

Team VisuStella

  • Archeia
  • Yami
  • Dan "Kaliya" Deptula

Changelog

Version 1.02: December 18, 2020

  • Fixed a bug wherein balloon icons would crash the game.


  • Version 1.00
    • Plugin released!

Help File