1 ‐ User's Manual - Z-H-Sun/tswKai GitHub Wiki

The Readme provides a brief introduction on how to use the basic functions of this project. For more details, please read this user's manual.

You will need a Windows OS to run this software. Windows XP and later platforms are recommended. The software is not guaranteed to run properly on earlier versions of Windows or on an emulator. No other system requirements are needed.

This project is free software, licensed under MIT License. Copyright (C) 2020-2026 Z.Sun

This project contains two parts:

• The patched TSW game program, TSW V1.2-rev

  For its usage, see 1.1 - Run TSW Game

• The game modifier, tswKai3

  For its usage, see 1.2 - Run tswKai3

In addition, if you are interested in the development of this project,

• See the 2 - Developers chapter

It is recommended to download the all-in-one package.

Extract its contents into any path you like (preferably a permanent path), and no need to install. It will take up ~35 MB space.

If you have previously downloaded and run an older version of the all-in-one package, please keep the old-version game folder for now; otherwise, your game data will get lost.

• Download the latest version of the all-in-one package through the link above.
• Extract the new-version package, but not to the same path as the old version (otherwise, this operation may overwrite your game options and ranking data).
• After extracting the new package, run tswLauncher.exe in the package. At startup, a message box will pop up: "Do you want to start migrating now?" Click "Yes" (or, click on the "Migrate" button later in the main dialog) to complete data backup, as shown in the picture below.
• Only after completing the backup operation can you safely delete the old-version game folder.

Click here for more details...

• [New features] tswLauncher:
  • Add "migration" and "patch configuration" functions
    • Migrate: Back up options, rankings, and data, etc., from other versions of TSW to the current installation path
    • Config: Customize the game frame rate, configure patches, and modify fonts, etc., for the specified TSW executable
  • Major improvements on GUI (as well as for developers, on compilation)
• [Bug fixes] General:
  • Add anti-overlapping function for the "Config (Dynamic)" dialog and the "Cheat Console" window: Previously, they could be overlapped by the TSW game window, causing them to be invisible; now these windows are ensured to be always in front of the game window
  • Fix a bug that might cause tswKai3 to crash when TSW quits (Issue #2)
  • Fix mojibake issues of Chinese dialog texts in tswKai3 on a non-Chinese OS; change console code page
  • Allow cleanup routine to be performed after an exception occurs in tswKai3.exe
  • Other minor fixes: adjusting TSW timers and window titles, code efficiency, resource management, etc.
• [Bug fixes] tswKai:
  • Fix the bug that "Life Pt (HP)" and "Altar Visits" had the same shortcut key L; the latter has been changed to V
• [Bug fixes] tswSaveLoad:
  • Fix a bug that TSW would fail to load data #8 after tswKai3 quits

• [Bug fixes] tswMod / tswRev:
  • Fix a bug that the keyboard hook would be unexpectedly disabled after F8 is pressed when TSW has an active popup child
  • Fix TSW 33F trap room bug
  • Fix multiple erroneous bytes

• [Bug fixes] tswMovePoint:
  • Fix a bug when pressing TAB during which TSW quits
  • Fix a bug when pressing TAB during an event: Previously the item bar hightlight and the message bar could not properly deactivate
  • Fix a bug related to the judging mechanism on "whether currently in an event"
• [Improvements] General:
  • The current version number of tswKai3 will be displayed on the title of dialogs and message boxes
  • (For developers:) Add a playground-mode executable tswKai3_rt.exe that can run the latest Ruby source code for tswKai3
  • (For developers:) Improve compilation (improved workflow and better compatibility with latest compilers)
• [Improvements] tswKai:
  • Avoid unnecessary message beeps
  • Adjust the upper limits of several variables to avoid 32-bit signed integer overflow
• [Improvements] tswMod / tswRev:
  • Stop previous WAV sound, if present, when loading data
  • Incorporate several important patches to TSW executables:
    • Allow loading during an event
    • Allow multiple WAV sounds to play consecutively within a short period of time
    • Prevent BGM / WAV options from being overridden during data saving / loading
  • (For developers:) Add a configuration ($CONrevStatus) to turn off certain important patches upon tswKai3 startup (e.g., those listed above)
  • (For developers:) Improve font replacement for TSW's popup windows
• [Improvements] tswMovePoint:
  • For on-map damage: The value of magic attack damage will be displayed in the center of the tile to be differentiated from normal damage
  • For on-map damage: In addition to normal ground tiles with magic attack damage, magic attack damage values will now be displayed also on door and item tiles
  • For mouse fast-move: The player's facing direction will be altered according to the location of the destination
  • For item shortcut-keys: When using Orb Of Flight, the cursor range will continue being clipped to avoid mouse misoperation; in addition, flying will be immediately aborted if interrupted (e.g., new dialog shown)

Click here for more details...

• tswRev:
  • Improve keyboard control of player movement by shortening the delay when holding down an arrow key
  • Improve player / monster movement animation tweens, which are made much smoother
  • Improve stair and door-opening animations by shortening the animation duration in fast / superfast speed modes
  • Improve battle animations such that animations for neighboring battle rounds are separated clearly
  • Fix the wrong GOLD income prompt after defeating a "strike-first" monster when holding the Lucky Gold (the income should double) and the wrong prompt after finishing the 40F boss battle
  • Improve positioning of the game window on the screen (On startup, will be positioned at the primary screen center; on size change, will try to grow / shrink the window with its center position preserved, but the window will not exceed the primary screen edges)
  • Improve default dialog window title and font
  • Bug fixes for the superfast speed mode: speed up epilog animation; reset timer interval after epilog; fix a bug of multiple menu item ticks for speed modes
• tswMod:
  • Add a configuration ($CONmsgOnTSWstartup) to turn off startup tutorial message box
  • If the multiplication factor for backside tower properties is changed (see below), the 45F merchant HP reward and the values in game tip texts will change accordingly
• tswKai:
  • Add an option to change the backside tower property multiplication factor
  • Add more specific operation instructions
  • Allow using arrow keys to navigate among items in the console
  • Allow using Enter / Space to cancel when the input is empty
  • Other minor fixes
• tswMovePoint:
  • Bug fix: GDI resource leak
  • Bug fix: In backside, after you see the on-map damage, if you press F8 after your HP/ATK/DEF/GOLD changes, the previous HP/ATK/DEF/GOLD would be incorrectly shown
  • Bug fix: Conflicts between mouse and keyboard control in absence of Orb of Flight (Currently, arrow keys will be disabled when hotkey is pressed)
• tswSaveLoad:
  • Bug fix: If a data is loaded in the middle of an event, there was a chance that the timer interval would not be correctly reset
• tswBGM:
  • Bug fix: If the "Enhance BGM playback" option is initially turned off, there was a bug that the current game would restart when this app quits

First stable release of Version 3