godot-card-game-framework - 戈多 卡牌游戏框架

项目说明

Godot Card Game Framework 2.2

![GUT]()

!Godot Card Game Framework preview image

This 框架 is meant to provide well designed, statically typed, and fully commented classes and scenes which you can plug into any potential card 游戏 to handle typical behaviour expected from cards in a 游戏 in a polished manner.

Pull requests are more than welcome ;)

Provided features

* Complete card text and rules enforcement capacity, Scripting 引擎! (see scripting 引擎 features, below)
* Tween & GDScript-based animations that look good for card mo.
* Customizable card highlights
* Supports Rich Text for card text, including embedded images.
* Choice between Oval or Straight hand shape
* Automatic focus-in on cards when moused o.
* Automatic re-arranging of hand as cards are added or removed.
* Drag & Drop of cards on table and between containers
* Supports having multiple hands and piles.
* Piles of cards represent their size .
* Larger image of card when moving mouse cursor over it
* Pop-up buttons for predefined functions on cards and card containers
* Option to look inside the piles and choose cards to move out
* Cards can rotate on the table
* Cards can attach to other cards and mo as a group.
* Cards can target other cards with a draggable arrow
* Can flip cards face-down and view them while in that state
* Can add tokens on cards. Tokens expand in the own drawer for more info.
* Ability to define cards in standard dictionaries
* Ability to split card definitions into sets
* Automatically resizing text inside cards to fit the card size.
* Supports resizing the window, in all stretch modes (including disabled stretch)
* Can select layout of your CardContainers from a simple drop-down menu.
* Automatic and manual Grid-based, or Free-form placement on the board, or a combination of both, on a per-card-type basis.
* Functions from saving/loading settings from disk.
* Caching mechanisms to reduce loading and instancing times.
* Collecting game statistics
* Easy customization . Dark Theme used in Demo, provided by Mounir Tohami
* A functional and customizable Card Library.

!Godot Card 游戏 框架 card library preview image

* A functional and customizable Deck Builder.

!Godot Card 游戏 框架 deck builder preview image

Scripting Engine Features

* Can define card scripts in plain text, using dictionaries.
* Can set cards to trigger off of any board manipulation.
* Can filter the triggers based on card properties, or a special subset.
* Can define optional abilities.
* Can define multiple-choice abilities.
* Can calculate effect intensity based on state of the board during runtime.
* Can request simple inputs from the player during execution.
* Tag-marking scripts which can be filtered by scripts triggering off of them.
* Can store results from one script to use in another.
* Can be plugged into by any object, not just cards.

All of the abo being very easily extensible to your own 游戏's special requirements through simple dictionaries.

Easy Customization

The classes provide some easy customization options, such as the card size, how the card mo they appear etc.

Check the Behaviour Constants of CFConst.gd for detailed information on what each does.

For more fine-tuned customization than that, you'll need to modify the 代码 manually

Easy to Upgrade

This 框架 has been designed with the idea that it can easily be upgraded to receive new features. Look at the Upgrade section within the Install guide for more info.

Usage

Most of the card manipulation functionalities work without any extra work, as long as the relevant scenes have been setup correctly (see Installation). For example, the 代码 which handles moving cards around or focusing on them etc should work out of the box.

However some effects require some trigger, such as targeting of cards etc. The method calls to perform these are a to use and some demo functions have been provided to understand how it works, but it is expected that each 游戏 will provide their own logic in their own scripts to call the relevant methods.

You can find documentation about all the provided methods in the wiki

Demonstrations

#### Card Manipulation buttons

Hover over the card to reveal its manipulation buttons.

#### Targeting

Right-click and hold on a a card to begin dragging a targeting arrow. Release right-click on top of a card to target it.

#### Attachments

Click on the "Enable Attachment" toggle to make all cards act as attachments and therefore allow them to attach to others.

Card Rotation

Click on either the 'T' or '@' buttons. Click again the same button to revert to 0 degrees.

Tokens/Counters

Click on the 'O' Button, to start adding one of four random tokens to the card.

Click on the +/- buttons next to each Token to add/remove that token specifically

Card Flip Face-Up/Face-Down

Click on the 'F' button to exchange between these two states

Grid-placement

The demonstration board has been setup with two different grid placements you can use. Try drag & dropping a card to either "PlacementGridDemo" or "This Grid has a modified label".

Card Scripts

The first four cards you will draw from your deck each ha prepared automations.
Their text explains these effects.

You can double click any of them in the hand or board to see their scripts in action.

Some of them have also effects that trigger off of other effects.

Mind that their script effect change, depending on whether they're in the hand or board, so make sure you move them to the board first if you want to see those scripts in action.

Installation

Please see the Install Guide

Scripting Engine

One of the most powerful features of this 框架, is the possibility to easily script each indi card's abilities from start to finish, so that a player only needs to double-click on a card and your 代码 will handle the proper execution. This allows games to very easily create complete rules enforcement of all card abilities, from the simplest to the most tricky ones.

Please see the ScriptingEngine documentation for more details.

The 游戏 comes with some sample scripted cards which can be found under res://src/custom/cards/sets.

Getting help, talking dev, or general chat

You can join us on Matrix () or Discord ()

Contributing

Please see the Contribution Guide

Support

If you wish to support the de of the Card 游戏 框架, consider becoming a patron via liberapay

Credits

Some initial ideas were taken from this excellent Godot Card 游戏 Tutorial video series. This 框架 uses some of the concepts but also attempts to create better quality 代码 in the process.

License

This software is licensed undel AGPL3. However an addendum has been added to allow distribution and integration with Steamworks SDK.

Games Made with CGF

* Hypnagonia
* Fragment Forge
* Torah Timeline

技术栈

开发语言：GDScript

项目类型：Godot 卡牌游戏框架

Star 数：1401

功能特点

这是一套Godot 卡牌游戏框架，代码结构清晰，适合开发者学习游戏的客户端渲染、服务端逻辑、场景管理与资源加载。项目涵盖了游戏的核心玩法、界面交互、地图与角色系统等模块，对理解游戏开发的完整流程具有较高的参考价值。

从技术实现角度看，游戏项目的难点在于：游戏循环与状态管理、资源加载与渲染优化、客户端与服务端的协议同步、以及多平台适配。本项目在这些方面提供了可运行的实现，开发者可以在此基础上进行二次开发或学习研究。

部署说明

1. 下载源码压缩包，解压到本地开发环境。

2. 根据项目类型准备对应的运行环境（Node.js / Go / C# / Unity / Godot 等）。

3. 按照 README 中的步骤配置依赖、数据库和配置文件。

4. 先启动服务端，再运行客户端，即可进入游戏进行测试。

注意：本项目仅供学习研究使用，请勿用于商业或非法用途。

学习价值

对于想进入游戏开发领域的开发者来说，这套源码是一个很好的入门参考。通过阅读代码，可以学习到游戏的核心玩法实现、场景与资源管理、网络协议设计、以及渲染优化等关键技术点。

同时，项目中的代码组织方式和模块划分，也展示了游戏项目在工程化方面的实践经验，值得开发者深入研究和借鉴。理解一个完整游戏项目的架构，对后续开发其他类型游戏也很有帮助。

免责声明

本资源来源于开源社区，仅供学习研究和技术交流使用，请勿用于任何商业或违法违规用途。使用本项目产生的一切后果由使用者自行承担。若涉及第三方权益，请联系删除。