TekkenScript Doc

Quick Start Guide #

Welcome to the Tekken Auto Script SDK Quick Start Guide. This page will help you set up your development environment and get you started with writing your first automation script using Notepad++.

Prerequisites #

Before you begin, ensure you have the following:

Step 1: Download and Install Notepad++ #

If you haven't installed Notepad++ yet, follow these steps:

  1. Download Notepad++:

  2. Install Notepad++:

    • Run the downloaded installer.
    • Follow the on-screen instructions to complete the installation.

Step 2: Setting Up Your Workspace #

Once you have Notepad++ installed, you can start setting up your workspace:

  1. Open Notepad++:

    • Launch Notepad++ from your desktop or Start menu.

  2. Create a New Lua Script File:

    • Go to File > New to create a new file.
    • Save the file with a .lua extension in the Software folder\scripts\Character\Character Name.lua directory, matching the name of the character you are scripting for (e.g., Xiaoyu.lua).
    • The corresponding hero name can be found in Software folder\scripts\_SDK\data.lua, or you can edit this file to add custom characters

  3. Enable Syntax Highlighting for Lua:

    • To make coding easier, enable Lua syntax highlighting by going to Language > L > Lua.

Step 3: Writing Your First Script #

Now that your workspace is ready, let's write a simple script using the Tekken Auto Script SDK.

  1. Write the Script:

    • Open your .lua file and start writing your script. Here’s an example to get you started:
    return {
    duck_whiff_punish = function(self, enemy, frames)
        print("duck_whiff_punish:" .. frames)
        --Ignore the next attack Combo1 Start
        if frames < 13 then
            executeMacro(0, Input.L_HAND, 3, InputType.KEY_PRESS)
            executeMacro(0, Input.R_HAND, 3, InputType.KEY_PRESS)
            return
        end
    end,
    onAttackSuccess = function(self, enemy, frames)
        print("Attack succeeded! Enemy ID: " .. enemy.move_id)
    end
}

  2. Save the Script:

    • Go to File > Save or press Ctrl + S to save your script.

Step 4: Running Your Script #

After writing your script, you can integrate it with the Tekken Auto Script SDK and run it within the game.

  1. Load the Script into the SDK:

    • Follow the SDK’s instructions to load your script into the game, ensuring it is in the correct Character directory.

  2. Test Your Script:

    • Launch Tekken and test your script to see it in action.

Troubleshooting #

If you encounter any issues:

  • Double-check your Lua syntax for errors.
  • Ensure the script is correctly integrated with the SDK.
  • Refer to the SDK documentation for additional support.

Conclusion #

You’ve now set up your environment, written, and tested your first automation script. Notepad++ is a powerful tool that makes Lua scripting efficient and straightforward. Continue exploring the SDK to unlock more advanced features and enhance your Tekken gameplay!

For more detailed guides, please refer to the full documentation.

Table