Samurais-Scripts

KO | EN

gitlite — search

#javascript #ai #typescript #golang #go #android #rust #macos #nodejs #awesome #kubernetes #vue #openai #mcp

Samurais-Scripts

(★ 64)

A base for a Lua script centered around roleplaying and having fun in a game full of ad bots and toxic cheaters.

Samurais-Scripts Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h3>Supported Builds</h3>

<details>
  <summary><strong>Table of Contents</strong></summary>
  <ul>
    <li><a href="#about">About</a></li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#setup">Setup</a></li>
        <li><a href="#commands-console">Commands Console</a></li>
      </ul>
    </li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#documentation">Documentation</a></li>
    <li><a href="#features">Features</a></li>
    <li><a href="#faq">FAQ</a></li>
    <li><a href="#contact">Contact</a></li>
    <li><a href="#acknowledgments">Acknowledgments</a></li>
  </ul>
</details>
<br>

# About

![ss](https://raw.githubusercontent.com/YimMenu-Lua/Samurais-Scripts/main/docs/ss.png)

A modular GTA V Lua framework focused on enhancing the player's experience through fun features, online business options, and unpopular opinions.

## Getting Started

### Setup

- Download the latest zip archive from the [releases section](https://github.com/YimMenu-Lua/Samurais-Scripts/releases/latest).
- Extract the archive and place the `SSV2` folder in YimMenu's `scripts` folder:

%AppData%\YimMenu\scripts

- Once in-game, press **[F5]** to toggle the script's UI.

>[!Note]
> Releases are scheduled for Sundays at 8AM.

### Commands Console

- Use **[F4]** to toggle the console window.
- Type `!ls` or `!dump` to dump all available commands.
- All default commands are prefixed with an exclamation mark `<!>`.

## Contributing

Contributions are what make the open source community a great place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also simply open a [feature request](https://github.com/YimMenu-Lua/Samurais-Scripts/issues/new?template=request.yml).

Don't forget to give the project a star!

1. Fork the repo
2. Create your feature branch.
3. Commit your changes.
4. Open a Pull Request.

Refer to the [Contribution Guidelines](./CONTRIBUTING.md) for more details on the project's structure and conventions.

## Documentation

This project was rewritten from scratch using the [SmallBase](https://github.com/xesdoog/SmallBase) template.

A full documentation will be uploaded to this repository soon. In the meantime, feel free to explore [SmallBase's docs](https://github.com/xesdoog/SmallBase/tree/main/docs).

>[!Note]
> Some parts of the API were refactored or extended but nothing has drastically changed.
> All changes introduced in this project are documented in the source.

## Features

A full list of available features and their usage [can be found here](docs/Features.md).

## FAQ

- **Q:** Does this support Enhanced?
- **A:** Partially. You can use [YimLuaAPI](https://github.com/TupoyeMenu/YimLuaAPI) to test it but stability is not guaranteed as of now.

- **Q:** What is YimLuaAPI and how do I use it?
- **A:**
  - **What is it:** [YimLuaAPI](https://github.com/TupoyeMenu/YimLuaAPI) is a universal Lua API that works for both Legacy and Enhanced.
  - **How to use it:** Right now there is no release because it's still in development. If you want to try it, you have to compile it yourself. Once you have `YimLuaAPI.dll`, inject it into any GTA branch (Legacy/Enhanced), it will create a folder on first injection: `%AppData%\YimLuaAPI`. Simply place the script there and you're done. You can still use YimMenu/YimMenuV2 but the script has to only exist in YimLuaAPI.

- **Q:** Why can't-I run this in YimMenuV2?
- **A:** There are several reasons why:
  - YimMenuV2 doesn't have a finished Lua API. `require` isn't even present, let alone custom bindings.
  - There are several versions and flavors of the Lua programming language. This project is written in [Lua 5.4](https://www.lua.org/manual/5.4/) and YimMenuV2's API uses [LuaJIT](https://luajit.org/). Explaining the difference here is not ideal but it's not only the language difference, it's also how they are embedded in each menu.

- **Q:** Can this be made compatible with YimMenuV2 once its API is finished?
- **Short Answer:** No.
- **Long Answer:** Yes, a compatibility layer can be added to handle all language and API differences but is it worth the trouble and code bloat? Absolutely not. We would be better off rewriting this for V2's API.

## Contact

## Acknowledgments

| Name | Contribution |
| :---: | :---: |
| <a href="https://github.com/harmless05"><img height="40" width="40" alt="Harmless" src="https://avatars.githubusercontent.com/harmless05"><br/>Harmless</a> | Shift-Drift |
| <a href="https://github.com/NiiV3AU"><img height="40" width="40" alt="NiiV3AU" src="https://avatars.githubusercontent.com/NiiV3AU"><br/>NiiV3AU</a> | German translations |
| <a href="https://github.com/gir489returns"><img height="40" width="40" alt="gir489returns" src="https://avatars.githubusercontent.com/gir489returns"><br/>gir489returns</a> | [Casino Pacino](https://github.com/YimMenu-Lua/Casino-Pacino) |
| <a href="https://github.com/tupoy-ya"><img height="40" width="40" alt="tupoy-ya" src="https://avatars.githubusercontent.com/tupoy-ya"><br/>tupoy-ya</a> | Several contributions and shared knowledge. Owner of [YimLuaAPI](https://github.com/TupoyeMenu/YimLuaAPI) |
| <a href="https://github.com/szalikdev"><img height="40" width="40" alt="szalikdev" src="https://avatars.githubusercontent.com/szalikdev"><br/>szalikdev</a> | Revived the project and joined the cause. Owner of [Acid Labs](https://github.com/acidlabsdev) |
| <a href="https://github.com/How-Bout-No"><img height="40" width="40" alt="How-Bout-No" src="https://avatars.githubusercontent.com/How-Bout-No"><br/>How-Bout-No</a> | Enhanced compatibility (YimLuaAPI), Mastermind module, and more. |
| <a href="https://github.com/shinywasabi"><img height="40" width="40" alt="Arthur" src="https://avatars.githubusercontent.com/shinywasabi"><br/>ShinyWasabi</a> | [scrDbg](https://github.com/ShinyWasabi/scrDbg) and other foundational community contributions frequently used as reference |
| <a href="https://github.com/durtyfree"><img height="40" width="40" alt="DurtyFree" src="https://avatars.githubusercontent.com/durtyfree"><br/>Alexander Schmid</a> | [GTA V data dumps](https://github.com/DurtyFree/gta-v-data-dumps) |
| <a href="https://github.com/yimura"><img height="40" width="40" alt="Yimura" src="https://avatars.githubusercontent.com/yimura"><br/>Andreas Maerten</a> | GTA V classes (archived/removed) |
| <a href="https://github.com/sch-lda"><img height="40" width="40" alt="SCH" src="https://avatars.githubusercontent.com/sch-lda"><br/>sch-lda (SCH)</a> | [MiniGameHack](https://github.com/YimMenu-Lua/MiniGameHack) |
| <a href="https://github.com/TCRoid"><img height="40" width="40" alt="TCRoid" src="https://avatars.githubusercontent.com/TCRoid"><br/>TCRoid (Rostal)</a> | [SoloMissions](https://github.com/YimMenu-Lua/SoloMissions) |
| <a href="https://unknowncheats.me"><img height="40" width="40" alt="UC" src="https://avatars.githubusercontent.com/u/29552835"><br/>UnknownCheats</a> | A treasure trove of information |

## TODO

- [ ] Generate our own docs since we're no longer in sync with [SmallBase](https://github.com/xesdoog/SmallBase).
- [ ] Fully Refactor EntityForge.
- [ ] Add support in YimActions for defining custom animations. This will require extracting EntityForge's attachment handler into a reusable module for animation prop configuration.

Samurais-Scripts

Samurais-Scripts Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Samurais-Scripts

Samurais-Scripts Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README