Skip to content

Latest commit

 

History

History
181 lines (124 loc) · 8.15 KB

README.md

File metadata and controls

181 lines (124 loc) · 8.15 KB
Raw

Fork notes

Formerly, this was an attempt to port Kilkakon's fork of Shimeji-ee from JRE 6 to JDK 21. I switched to porting to JDK 11 to maintain the most compatibility possible, though it is still compatible with JDK 21.

This fork also contains bug fixes, log message changes, fixes in the default mascot action/behavior XML files, more documentation (including comments and documentation from the original Shimeji, now translated through a better Google Translate than before), updated dependencies, formatting fixes, and probably more. Notably, I have also switched the project from Ant to Maven, and ported the launch4j.xml file from the original Shimeji to the Launch4j Maven Plugin.

(It also has WIP Linux support, though it was just copied and modified from asdfman's fork and doesn't entirely work yet. I can only test it by using a VM, so that doesn't help.)

The rest of this file is the original README, albeit ported to Markdown.

Shimeji-ee: Shimeji English Enhanced

Shimeji-ee is a Windows desktop mascot that freely wanders and plays around the screen. The mascot is very configurable; its actions are defined through xml and its animations/images can be (painstakingly) customized. Shimeji was originally created by Yuki Yamada of Group Finity. This branch of the original Shimeji project not only translates the program/source to English, but adds additional enhancements to Shimeji by Kilkakon and other members of the community.

Contents

  1. Homepage
  2. Requirements
  3. How to Start
  4. Basic Configuration
  5. Advanced Configuration
  6. How to Quit
  7. How to Uninstall
  8. Source
  9. Library
  10. Trouble Shooting

Homepage

Homepage: http://kilkakon.com/shimeji

Requirements

  1. Windows Vista or higher
  2. Java 8

How to Start

  1. Double-click the Shimeji-ee file (Shimeji-ee.jar).
  2. Right-click the tray icon for general options.
  3. Right-click a Shimeji for options relating to it.

For a tutorial on how to get Shimeji running, watch this video: https://www.youtube.com/watch?v=S7fPCGh5xxo

You can also watch the FAQ if you encounter problems: https://www.youtube.com/watch?v=A1y9C1Vbn6Q

You can also join my Discord group: https://discord.gg/dcJGAn3

Basic Configuration

If you want multiple Shimeji types, you must have multiple image sets. Basically, you put different folders with the correct Shimeji images under the img directory.

For example, if you want to add, say, a new Batman Shimeji:

  1. Create an img/Batman folder.
  2. You must have an image set that mimics the contents of img/Shimeji. Create and put new versions of shime1.png - shime46.png (with Batman images of course) in the img/Batman folder. The filenames must be the same as the img/Shimeji files. Refer to img/Shimeji for the proper character positions.
  3. Start Shimeji-ee. Now Shimeji and Batman will drop. Right click Batman to perform Batman specific options. Adding "Call Shimeji" from the tray icon will randomly create add either Shimeji or Batman.

When Shimeji-ee starts, one Shimeji for every image set in the img folder will be created. If you have too many image sets, a lot of your computer's memory will be used... so be careful. Shimeji-ee can eat up to 60% of your system's free memory.

Shimeji-ee will ignore all the image sets that are in the img/unused folder, so you can hide image sets in there. There is also a tool, Image Set Chooser, that will let you select image sets at run time. It remembers previous options via the conf/settings.properties file. Don't choose too many at once.

For more information, read through the configuration files in conf/. Most options are somewhat complicated, but it's not too hard to limit the total number of Shimeji or to turn off certain behaviors (hint: set frequency to 0.)

Advanced Configuration

All configuration files are located in the conf folders. In general, none of these should need to be touched.

The logging.properties file defines how logging errors is done.

The actions.xml file specifies the different actions Shimeji can do. When listing images, only include the file name. More detail on this file will hopefully be added later.

The behaviors.xml file specifies when Shimeji performs each action. More detail on this file will hopefully be added later.

The settings.properties file details which Shimeji are active as well as the windows with which they can interact. These settings can be changed using the program itself.

Each type of Shimeji is configured through:

  1. An image set. This is located in img/[NAME]. The image set must contain all image files specified in the actions file.
  2. An actions file. Unless img/[NAME]/conf/actions.xml or conf/[NAME]/actions.xml exists, conf/actions.xml will be used.
  3. A behaviors file. Unless img/[NAME]/conf/behaviors.xml or conf/[NAME]/behaviors.xml exists, conf/behaviors.xml will be used.

When Shimeji-ee starts, one Shimeji for every image set in the img folder will be created. If you have too many image sets, a lot of your computer's memory will be used... so be careful. Shimeji-ee can eat up to 60% of your system's free memory.

Shimeji-ee will ignore all the image sets that are in the img/unused folder, so you can hide image sets in there. There is also a tool, Image Set Chooser, that will let you select image sets at run time. It remembers previous options via the conf/settings.properties file. Don't choose too many at once.

The Image Set Chooser looks for the shime1.png image. If it's not found, no image set preview will be shown. Even if you're not using an image named shime1.png in your image set, you should include one for the Image Set Chooser's sake.

Editing an existing configuration is fairly straightforward. But writing a brand-new configuration file is very time-consuming and requires a lot of trial and error. Hopefully someone will write a guide for it someday, but until then, you'll have to look at the existing conf files to figure it out. Basically, for every behavior, there must be a corresponding action. Actions and behaviors can be a sequence of other actions or behaviors.

The following actions must be present for the actions.xml to be valid:

  • ChaseMouse
  • Fall
  • Dragged
  • Thrown

The following behaviors must be present for the behaviors.xml to be valid:

  • ChaseMouse
  • Fall
  • Dragged
  • Thrown

The icon used for the system tray is img/icon.png.

How to Quit

Right-click the tray icon of Shimeji, and select "Dismiss All".

How to Uninstall

Delete the unzipped folder.

Source

Programmers may feel free to use the source. The Shimeji-ee source is under the New BSD license. Follow the zlib/libpng licenses.

Library

lib/jna.jar and lib/jna-platform.jar of the JNA library. JNA follows the LGPL.

lib/AbsoluteLayout.jar from Netbeans.

Trouble Shooting

For a tutorial on how to get Shimeji running, watch this video: https://www.youtube.com/watch?v=S7fPCGh5xxo

You can also watch the FAQ if you encounter problems: https://www.youtube.com/watch?v=A1y9C1Vbn6Q

You can also join my Discord group: https://discord.gg/dcJGAn3

Shimeji-ee takes a LOT of time to start if you have a lot of image sets, so give it some time. Try moving all but one image set from the img folder to the img/unused folder to see if you have a memory problem. If Shimeji is running out of memory, try editing Shimeji-ee.bat and change -Xmx1000m to a larger number.

If the Shimeji-ee icon appears, but no Shimeji appear:

  1. Make sure you have the newest version of Shimeji-ee.
  2. Make sure you only have image set folders in your img directory.
  3. Make sure you have Java on your system.
  4. If you're somewhat computer savvy, you can try running Shimeji-ee from the command line. Navigate to the Shimeji-ee directory and run this command: "C:\Program Files\Java\jre-1.8\bin\java" -jar Shimeji-ee.jar
  5. Try checking the log (ShimejiLogX.log) for errors. If you find a bug (which is very likely), post it up on the Shimeji-ee homepage in the issues section.