samp.directory
← Scripts e bibliotecas

pnwjdw/AsiSDK-by-yorenov

AsiSDK by yorenov — C++20 SDK для ASI-плагинов GTA San Andreas 1.0 US и SA-MP: примеры, документация, релизы

Outro★ 2atualizado há 9 diasSem licença
Abrir no GitHub

Este repositório não tem arquivo de licença. Ele é público para leitura, mas isso sozinho não dá permissão para reutilizar.

README.md

AsiSDK by yorenov

Статическая библиотека для написания ASI-плагинов GTA San Andreas 1.0 US и SA-MP на C++20.

API повторяет имена MoonLoader (sampAddChatMessage, createCar, lua_thread.create, wait), но вместо Lua даёт типизированный C++: корутины вместо lua_thread, Result<T> вместо пар result, value, отдельные типы для хендлов, моделей и ID SA-MP, RAII для ресурсов. Всё, включая MinHook, Dear ImGui, stb и miniaudio, уже внутри AsiSDK.lib: готовому плагину не нужны lua51.dll, CLEO, SAMPFUNCS, D3DX, BASS или LuaExecutor.

Скачать SDK (релиз 1.1.0) · Документация · Примеры · Изменения

Загрузочный экранПодпись SDK в меню
Рендер поверх игрыDear ImGui

Возможности

  • Задачи на корутинах — asi::lua_thread::create, co_await asi::wait(ms), gameReady(), sampReady(), пауза, перезапуск и отмена без отдельных потоков.
  • Функции игры — функции MoonLoader и обёртки для 1448 опкодов с типами хендлов и проверкой ошибок.
  • SA-MP 0.3.7 R1, R2, R3, R4, R4-2, R5: чат, команды, диалоги, игроки, транспорт, текстдравы.
  • Сеть — перехват, блокировка и замена входящих и исходящих RPC и пакетов.
  • Рендер — шрифты с кириллицей и цветовыми тегами, примитивы, текстуры, спрайты; восстановление после сброса устройства.
  • Dear ImGui — готовый контекст, захват ввода, свои шрифты и стили (gui::onInitialize), DXUT-совместимые окна.
  • Звук — MP3, WAV, FLAC и OGG из памяти и файлов, 3D-источники.
  • Память и нативные вызовы, SAMPFUNCS-совместимые SCM-потоки, CLEO, файлы, GXT, буфер обмена, JSON и INI.
  • Несколько плагинов в одной игре — общий брокер: одна копия хуков, экспорт функций между ASI, общие команды.
  • Загрузочный экран — любой ASI на AsiSDK показывает на загрузках ту же картинку, что и LuaExecutor. Отключить или заменить — одна строка в CMakeLists.txt.

Требования

КомпиляторVisual Studio 2022 (v143) или новее, инструменты C++ x86
СборкаCMake 3.25+ (входит в Visual Studio), Ninja или NMake
ПлатформаWindows x86 (Win32), C++20, Release, статический CRT (/MT)
ИграGTA San Andreas 1.0 US, любой ASI Loader (например, Silent's ASI Loader или Ultimate ASI Loader)

Что лежит в релизе

ФайлСодержимое
AsiSDK-1.1.0.zipвсё для своих плагинов: include/, lib/AsiSDK.lib, lib/AsiSDK_API.md, cmake/AsiSDK.cmake, THIRD_PARTY_NOTICES.txt
AsiSDK-1.1.0-examples.zipвсе примеры с копией SDK внутри каждого и уже собранными .asi

Исходный код самой библиотеки не публикуется: в релизе только заголовки, AsiSDK.lib и CMake-модуль.

Быстрый старт

  1. Скачайте AsiSDK-1.1.0.zip и распакуйте его в папку sdk\ рядом со своим проектом:

    MyPlugin\
      sdk\include\  sdk\lib\  sdk\cmake\
      CMakeLists.txt
      main.cpp
    
  2. CMakeLists.txt:

    cmake_minimum_required(VERSION 3.25)
    if(NOT CMAKE_BUILD_TYPE)
        set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type")
    endif()
    project(MyPlugin LANGUAGES C CXX)
    
    include("${CMAKE_CURRENT_SOURCE_DIR}/sdk/cmake/AsiSDK.cmake")
    
    asi_add_plugin(MyPlugin main.cpp)
    asi_set_output_directory(MyPlugin "${CMAKE_CURRENT_SOURCE_DIR}/bin")
    
  3. main.cpp:

    #include <asi/sdk.hpp>
    
    #include <string>
    #include <string_view>
    
    ASI_PLUGIN("HelloPlugin", "1.0") {
        asi::script_author("Автор");
        asi::script_description(u8"Команда /hello");
    
        asi::lua_thread::create([]() -> asi::Task {
            co_await asi::sampReady();
            auto command = asi::sampRegisterChatCommand("hello", [](std::string_view arguments) {
                std::string name = arguments.empty() ? std::string("игрок") : std::string(arguments);
                auto sent = asi::sampAddChatMessage("Привет, " + name + "!", 0xFF33CCFF);
                if (!sent) asi::log::warn(sent.error().message);
            });
            if (!command) asi::log::error(command.error().message);
        });
    }
    
  4. Соберите из x86 Native Tools Command Prompt for VS 2022 (или возьмите build.cmd из любого примера — он сам находит Visual Studio):

    cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
    cmake --build build
    
  5. Скопируйте bin\MyPlugin.asi в папку игры рядом с gta_sa.exe. Журнал плагина пишется в MyPlugin.log рядом с ASI.

Тело ASI_PLUGIN выполняется в игровом потоке на первом кадре, а не внутри DllMain. Плагин без Visual Studio (свой проект, другой генератор) настраивается по разделу 2 документации.

Загрузочный экран

По умолчанию ничего делать не нужно — показывается встроенная картинка. Отключить или заменить:

asi_add_plugin(MyPlugin main.cpp LOADING_SCREEN OFF)
asi_add_plugin(MyPlugin main.cpp LOADING_SCREEN "art/loading.png")

Подходят .png, .jpg, .jpeg, .bmp и .tga до 4096×4096. Как это работает с несколькими ASI и с LuaExecutor — в разделе 4 документации.

Примеры

В репозитории примеры лежат без SDK. Чтобы собрать их, распакуйте AsiSDK-1.1.0.zip в sdk\ в корне репозитория (рядом с examples\) и запустите build.cmd в папке примера. Готовый ASI появится в его bin\.

ПримерЧто показываетУправление
01_minimal_chat_commandкоманда чата и сообщение/hello
02_tasks_and_timersзадачи: ожидание, пауза, фон, перезапуск, ошибкиF2
03_network_hooksперехват, блокировка и замена RPC и пакетов/netinfo
04_render_and_guiтекст и примитивы поверх игры, окно ImGuiF3
05_entitiesмашины и метки с RAII-владением, моделиF10, Shift+F10, Ctrl+F10, /veh
06_audioзвук из памяти, 3D-источник, файлF11, Shift+F11, Ctrl+F11
07_config_unicode_clientINI и JSON, UTF-8 и CP1251, имя DLL клиента SA-MP—
08_events_and_sessionсобытия, данные в сохранениях, сообщения окна, хендлыInsert
09_two_pluginsдва ASI: экспорт функций, общие команды, выгрузка/alpha, /beta
10_lovlya_simokперенос скрипта mimgui: стиль, свои кнопки и переключатель, CEF-пакет 215F4, /lovlyasimok

Документация

docs/AsiSDK_API.md — полное руководство на русском: подключение, правила, все разделы API, таблица соответствия MoonLoader и AsiSDK, ограничения и приложение со всеми объявлениями заголовков. Тот же файл лежит в релизе как lib/AsiSDK_API.md.

Сторонние компоненты

Библиотека включает MinHook, Dear ImGui, stb и miniaudio. Их лицензии — в THIRD_PARTY_NOTICES.txt; этот файл нужно распространять вместе с плагинами, собранными на AsiSDK.

Обратная связь

Баги, вопросы и предложения — в Issues.

Автор — yorenov.

asiasi-plugincpp20gta-sagta-san-andreasimguimoonloadersampsdk

Esta página é montada com o que o GitHub publica sobre o repositório. O samp.directory não hospeda o código. Avisar de um problema com esta página

pnwjdw/AsiSDK-by-yorenov: Outro de SA-MP | samp.directory