# ygopro-core

**Repository Path**: chen_fang_yi/ygopro-core

## Basic Information

- **Project Name**: ygopro-core
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-26
- **Last Updated**: 2026-09-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# YGOPro script engine

## Introduction
The core logic and lua script processor of YGOPro. This library can be made external of the project and used to power server technologies. It maintains a state engine that is manipulated by Lua scripts using manipulation functions it exposes.

## Compiling
In most cases, what you want to compile is the main program of YGOPro. You should refer to the main YGOPro project's [wiki](https://github.com/Fluorohydride/ygopro/wiki).
If you want to compile the dynamic link library of this repository (ocgcore.dll), you can refer to [this script](https://github.com/Fluorohydride/ygopro-core/blob/master/.github/workflows/build.yml).

## Exposed Functions

The 3 functions need to be provided to the core so it can get card and database information.
- `void set_script_reader(script_reader f);`  
Interface provided returns scripts based on number that corresponds to a lua file, send in a string.

- `void set_card_reader(card_reader f);`  
Interface provided function that provides database information from the `datas` table of `cards.cdb`.

- `void set_message_handler(message_handler f);`  
Interface provided function that handles error messages.

These functions create the game itself and then manipulate it.
- `intptr_t create_duel(uint_fast32_t seed);`  
(Deprecated) Create an instance of `duel` with 1 uint32 PRNG seed.  
This function is reserved for replay mode only.

- `intptr_t create_duel_v2(uint32_t seed_sequence[]);`  
Create an instance of `duel` with PRNG seed `seed_sequence[]` of length `SEED_COUNT`.

- `void start_duel(intptr_t pduel, uint32_t options);`  
Start the duel.

- `void end_duel(intptr_t pduel);`  
End the duel.

- `void set_player_info(intptr_t pduel, int32_t playerid, int32_t lp, int32_t startcount, int32_t drawcount);`  
Set up the duel information.

- `void get_log_message(intptr_t pduel, char* buf);`

- `int32_t get_message(intptr_t pduel, byte* buf);`

- `int32_t process(intptr_t pduel);`  
Do a game tick.

- `void new_card(intptr_t pduel, uint32_t code, uint8_t owner, uint8_t playerid, uint8_t location, uint8_t sequence, uint8_t position);`  
Add a card to the duel state.

- `void new_tag_card(intptr_t pduel, uint32_t code, uint8_t owner, uint8_t location);`  
Add a new card to the tag pool.

- `int32_t query_card(intptr_t pduel, uint8_t playerid, uint8_t location, uint8_t sequence, uint32_t query_flag, byte* buf, int32_t use_cache);`  
Get a card in a specific location.

- `int32_t query_field_count(intptr_t pduel, uint8_t playerid, uint8_t location);`  
Get the number of cards in a specific location.

- `int32_t query_field_card(intptr_t pduel, uint8_t playerid, uint8_t location, uint32_t query_flag, byte* buf, int32_t use_cache);`  
Get all cards in some location.

- `int32_t query_field_info(intptr_t pduel, byte* buf);`

- `void set_responsei(intptr_t pduel, int32_t value);`

- `void set_responseb(intptr_t pduel, byte* buf);`

- `int32_t preload_script(intptr_t pduel, const char* script_name);`

- `byte* default_script_reader(const char* script_name, int* len);`  
The default script reader using `fread`.

# Lua functions
- `libcard.cpp`
- `libdebug.cpp`
- `libduel.cpp`
- `libeffect.cpp`
- `libgroup.cpp`