1 Star 0 Fork 41

王先生 / cardjs

forked from Yami / cardjs 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
AFL-3.0

card.js

这是一个游戏王卡片渲染工具,你只需要在你的网站引入card.js,就可以轻松地渲染出标准的游戏王卡图!

为什么使用card.js

你的网站需要大量的游戏王卡图,但是网上的卡图资源参差不齐?不妨试试card.js,只需要一次的加载,就可以使用大量、标准、高清的游戏王卡图。

  • 🥦 响应式。Card会自动响应数据的变动,同时更新卡图,这在与表单交互场景十分有用。同时,对于大量的更新请求,内部只会进行一次绘制,因此你不用过多的担心性能问题。

  • 🍅 十分容易使用。你只需要短短的几行代码,就能将一张canvas画布变成一张游戏王高清卡图!另外,card.js可以自由的更改模板样式,在config文件中你可以随心所欲地进行创作!

  • 🍉 交互式。你可以轻松实现各种交互动效,比如SR面闪特效、烫金字等。同时允许实时修改卡片信息、自由定制卡片。

  • 🍇 动态尺寸。Card渲染的卡图非常清晰,你可以直接保存到本地进行打印。同时Card会自动监听canvas的尺寸变化,同时会自动重绘。从显示器到纸张上,它是一张永远都不会模糊的图片。


🎈 作品

🔗 游戏王在线制卡器 #yami

🔗 游戏王WIKI #yami

欢迎向我自荐你的基于card.js的作品,邮箱:ymssx@qq.com


📦 安装

$ git clone https://gitee.com/ymssx/cardjs.git

dist文件夹下的内容放到需要的地方

目录结构

mold/

保存了我们需要的标准模板素材。当然你也可以自定义你的模板

config/

这里自带了几份常用的配置文件

card.js

手动引入它就可以使用Card啦


🚀 使用方式

dist文件夹的内容放在合适的位置,使用<script>引入card.js

<canvas id="card"></canvas>
...
<script src="xxx/card.js"></script>

传入一个卡片数据和canvas对象,然后使用render方法就可以渲染啦

const canvas = document.getElementById('card');
const data = { 
  name: '青眼的白龍',
  _id: '89631139',
  type: 'monster',
  type2: 'tc',
  type3: '',
  type4: '',
  attack: 3000,
  defend: 2500,
  level: 8,
  desc: '以高攻擊力著稱的傳說之龍。任何對手都能被粉碎,其破壞力不可估量。',
  race: '龍族',
  attribute: 'light' 
}

const card = new Card({ data, canvas, size: [400, 584] });

card.render();

注意,当card.js不在根目录时,你可能需要手动指定moldPath。

const card = new Card({ data, canvas, moldPath: './source/mold' });

data -- 卡片信息,包括名字、密码、效果等

interface data = {
  name: string,                          // card name
  _id: string,                           // card id
  type: 'monster' | 'spell' | 'trap',    // first type
  type2: type,                           // secend type 见下面注释①
  type3: type,                           // third type
  type4: type,                           // fourth type
  desc: string                           // card describe
  ?attribute: 'light' | 'dark' | 'fire' | 'water' | 'wind' | 'earth' | 'divine'
                                         // monster attribute
  ?race: string                          // monster race
  ?attack: number                        // monster attack
  ?defend: number                        // monster defend
  ?level: number                         // monster level

  ?link: boolean[]                       // link monster arrows
  ?lb_desc: string                       // pendulum describe
  ?lb_number: number                     // pendulum number
}

typeMap = { "tc": '通常', "xg": '效果', "ys": '儀式', "rh": '融合', "tt": '同調', "cl": '超量', "lb": '靈擺', "lj": '連接', "ec": '二重', "tz": '調整', "tm": '同盟', "tk": '卡通', "lh": '靈魂', "fz": '反轉', "ts": '特殊召喚', "zb": '裝備', "sg": '速攻', "cd": '場地', "fj": '反擊', "yx": '永續' }

① 关于type2 | type3 | type4

  • 描述卡片类型时,请一定在type2中反映出它是一张什么颜色的卡片,可选为 tc通常、xg效果、rh融合、ys仪式、cl超量、tt同调等
  • type3 - type4可描述为tz调整、ec二重、fz反转、tc通常、xg效果等
  • 默认使用拼音首字母描述,超过两个字的按前两个字处理,如“特殊召唤”为“ts”
  • TCG玩家也可以使用英文,如 normal、effect、fusion、ritual、xyz、synchro等(请使用小写),我们会自动转换为拼音

以下两种描述是等价的,请根据自己喜好选择

const data = { 
  name: '幽鬼兔',
  type: 'monster',
  type2: 'xg', // 效果
  type3: 'tz', // 调整
  type4: '',
}

const data = { 
  name: '幽鬼兔',
  type: 'monster',
  type2: 'effect', // 效果
  type3: 'tuner', // 调整
  type4: '',
}

🎏 游戏王卡图库

不知道去哪里找卡图?

这里收录了绝大多数游戏王卡图,不定期更新。

🔗 传送门


🎉 详细配置

const Card = function ({
  data: object,                           // 卡片数据
  canvas: HTMLElement,                    // canvas对象
  size: number[],                         // 绘制尺寸,[宽, 高]
  moldPath: string = './mold',            // 模板资源路径
  lang:'cn' | 'jp' | 'en' = 'cn',         // 语言 cn、jp、en
  config: object = defaultConfig,         // 配置信息。在这里指定你的自定义配置信息
  fontLoaded: function = defaultEvent,    // 事件
  imageLoaded: function = defaultEvent,
  fontsLoaded: function = defaultEvent,
  imagesLoaded: function = defaultEvent,
  loaded: function = defaultEvent,
  recover: boolean = false,               // 是否缓存配置与数据
  holo: boolean = true,                   // 是否显示防伪标志
  cardbagSwitch: boolean = false,         // 是否显示卡包信息
  translate: boolean = false,             // 是否自动繁简转换
  verbose: boolean = false                // 是否开启啰嗦模式
})

size

当传入的值为数组时,canvas会严格按照这个尺寸进行绘制。

const card = new Card({ data, canvas, size = [813, 1185] })

你也可以不传入size,如果autoResize为true(默认值),那么card.js会自动计算尺寸。

当canvas尺寸变化时,card.js会自动重新进行绘制,保证卡图永远高清,这在弹性布局中十分有用。

<style>
#card {
  width: 80%;
}
</style>

<canvas id="card"></canvas>
// autoResize默认开启
const card = new Card({ data, canvas, autoResize: true })

🌴 生命周期

通过传入事件来自定义卡片渲染的生命周期钩子函数。

fontLoaded

单个字体文件加载完成。

card.fontLoaded = function(e) {
  console.log(e);
}

fontsLoaded

所有字体文件加载完成。

imageLoaded

单个图片资源加载完成。

imagesLoaded

单个图片资源加载完成。

loaded

卡片渲染完毕。


🧰 config

更改config文件,可以自由地调整卡片的样式,比如字体大小、颜色等。

具体配置请参考config/defaultConfig.js

你可以通过传递一个配置对象来临时改变配置信息

card.changeConfig(config);

🧮 API

Card.render

await card.render();

初始渲染,返回一个promise对象,当绘制完毕时变为fulfilled状态。

Card.feed

你可以自由的使用与更换自定义的中间卡图。

比如当你想把【真红眼黑龙】的卡图换成【青眼白龙】。

const pic = document.getElementById('blueEyes');
card.feed(pic);

Card.changeConfig

card.changeConfig(config);

Card.feedData

调整卡片信息。

card.feedData(data);

或者直接

card.data.name = 'Blue Eyes';

Card.save

保存卡图到本地,你可以指定保存时文件名称图片尺寸

card.save('青眼白龙', [1626, 2370]);

也可以不指定参数,card.js会自动使用卡名作为文件名,尺寸会使用默认值1626 × 2370。

Card.feedFlash

使用面闪效果。传入一张闪面卡图,并且调整card.data.flash的值(0 ~ 1),卡图会呈现不同强度的面闪效果。

card.feedFlash(document.getElementById('flashImg'));

card.data.flash = 0.5;

一张闪面卡图需要自行制作,一下是两组例子:


静态方法

以下是Card对象私有的方法,请不要在实例对象上使用。

Card.complex

将简体字文本转换为繁体字文本。

const complexText = Card.complex('青眼白龙'); // 青眼白龍

Card.transData

card.js需要你以特定的JSON结构来描述一张卡,觉得麻烦?没关系,使用transData可以直接兼容YGOPro自带数据库的卡片数据

const ygoproData = {
  "name": '元素英雄 羽翼侠',
  "desc": "拥有操纵风在天空飞舞之翼的元素英雄。以来自天空的一击羽翼击破来审判邪恶。",
  "id": 21844576,
  "atk": 1000,
  "def": 1000,
  "race": 1,
  "type": 17,
  "level": 3,
  "attribute": 8
}
// 来自YGOPro的数据,直接传入card.js会报错
const newData = Card.transData(ygoproData);
console.log(newData);

输出

{
  name: '元素英雄 羽翼侠',
  desc: '拥有操纵风在天空飞舞之翼的元素英雄。以来自天空的一击羽翼击破来审判邪恶。',
  _id: '21844576',
  attack: 1000,
  defend: 1000,
  race: '战士族',
  type: 'monster',
  type2: 'tc',
  type3: '',
  type4: '',
  level: 3,
  attribute: 'wind'
}
// 可以被card.js理解的数据对象结构

🧶 实现方式

Card.js

  • 📚 cardData.js

管理卡片数据,监听数据变动,当数据更新之后,cardData会自动分析需要更新哪些文件,然后告知cardFile

  • 📁 cardFile.js

管理文件的更新与缓存,当收到cardData的更新请求后,会自动从缓存或者网络调用图片,在文件更新之后会自动告知cardDrawer

  • 🎨 cardDrawer.js

管理绘图功能,在收到cardFile的绘图请求后,会按照cardData的数据以及cardFile提供的文件进行绘图

Academic Free License (“AFL”) v. 3.0 This Academic Free License (the "License") applies to any original work of authorship (the "Original Work") whose owner (the "Licensor") has placed the following licensing notice adjacent to the copyright notice for the Original Work: Licensed under the Academic Free License version 3.0 1) Grant of Copyright License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, for the duration of the copyright, to do the following: a) to reproduce the Original Work in copies, either alone or as part of a collective work; b) to translate, adapt, alter, transform, modify, or arrange the Original Work, thereby creating derivative works ("Derivative Works") based upon the Original Work; c) to distribute or communicate copies of the Original Work and Derivative Works to the public, under any license of your choice that does not contradict the terms and conditions, including Licensor’s reserved rights and remedies, in this Academic Free License; d) to perform the Original Work publicly; and e) to display the Original Work publicly. 2) Grant of Patent License. Licensor grants You a worldwide, royalty-free, non-exclusive, sublicensable license, under patent claims owned or controlled by the Licensor that are embodied in the Original Work as furnished by the Licensor, for the duration of the patents, to make, use, sell, offer for sale, have made, and import the Original Work and Derivative Works. 3) Grant of Source Code License. The term "Source Code" means the preferred form of the Original Work for making modifications to it and all available documentation describing how to modify the Original Work. Licensor agrees to provide a machine-readable copy of the Source Code of the Original Work along with each copy of the Original Work that Licensor distributes. Licensor reserves the right to satisfy this obligation by placing a machine-readable copy of the Source Code in an information repository reasonably calculated to permit inexpensive and convenient access by You for as long as Licensor continues to distribute the Original Work. 4) Exclusions From License Grant. Neither the names of Licensor, nor the names of any contributors to the Original Work, nor any of their trademarks or service marks, may be used to endorse or promote products derived from this Original Work without express prior permission of the Licensor. Except as expressly stated herein, nothing in this License grants any license to Licensor’s trademarks, copyrights, patents, trade secrets or any other intellectual property. No patent license is granted to make, use, sell, offer for sale, have made, or import embodiments of any patent claims other than the licensed claims defined in Section 2. No license is granted to the trademarks of Licensor even if such marks are included in the Original Work. Nothing in this License shall be interpreted to prohibit Licensor from licensing under terms different from this License any Original Work that Licensor otherwise would have a right to license. 5) External Deployment. The term "External Deployment" means the use, distribution, or communication of the Original Work or Derivative Works in any way such that the Original Work or Derivative Works may be used by anyone other than You, whether those works are distributed or communicated to those persons or made available as an application intended for use over a network. As an express condition for the grants of license hereunder, You must treat any External Deployment by You of the Original Work or a Derivative Work as a distribution under section 1(c). 6) Attribution Rights. You must retain, in the Source Code of any Derivative Works that You create, all copyright, patent, or trademark notices from the Source Code of the Original Work, as well as any notices of licensing and any descriptive text identified therein as an "Attribution Notice." You must cause the Source Code for any Derivative Works that You create to carry a prominent Attribution Notice reasonably calculated to inform recipients that You have modified the Original Work. 7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that the copyright in and to the Original Work and the patent rights granted herein by Licensor are owned by the Licensor or are sublicensed to You under the terms of this License with the permission of the contributor(s) of those copyrights and patent rights. Except as expressly stated in the immediately preceding sentence, the Original Work is provided under this License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or implied, including, without limitation, the warranties of non-infringement, merchantability or fitness for a particular purpose. THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This DISCLAIMER OF WARRANTY constitutes an essential part of this License. No license to the Original Work is granted by this License except under this disclaimer. 8) Limitation of Liability. Under no circumstances and under no legal theory, whether in tort (including negligence), contract, or otherwise, shall the Licensor be liable to anyone for any indirect, special, incidental, or consequential damages of any character arising as a result of this License or the use of the Original Work including, without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses. This limitation of liability shall not apply to the extent applicable law prohibits such limitation. 9) Acceptance and Termination. If, at any time, You expressly assented to this License, that assent indicates your clear and irrevocable acceptance of this License and all of its terms and conditions. If You distribute or communicate copies of the Original Work or a Derivative Work, You must make a reasonable effort under the circumstances to obtain the express assent of recipients to the terms of this License. This License conditions your rights to undertake the activities listed in Section 1, including your right to create Derivative Works based upon the Original Work, and doing so without honoring these terms and conditions is prohibited by copyright law and international treaty. Nothing in this License is intended to affect copyright exceptions and limitations (including “fair use” or “fair dealing”). This License shall terminate immediately and You may no longer exercise any of the rights granted to You by this License upon your failure to honor the conditions in Section 1(c). 10) Termination for Patent Action. This License shall terminate automatically and You may no longer exercise any of the rights granted to You by this License as of the date You commence an action, including a cross-claim or counterclaim, against Licensor or any licensee alleging that the Original Work infringes a patent. This termination provision shall not apply for an action alleging patent infringement by combinations of the Original Work with other software or hardware. 11) Jurisdiction, Venue and Governing Law. Any action or suit relating to this License may be brought only in the courts of a jurisdiction wherein the Licensor resides or in which Licensor conducts its primary business, and under the laws of that jurisdiction excluding its conflict-of-law provisions. The application of the United Nations Convention on Contracts for the International Sale of Goods is expressly excluded. Any use of the Original Work outside the scope of this License or after its termination shall be subject to the requirements and penalties of copyright or patent law in the appropriate jurisdiction. This section shall survive the termination of this License. 12) Attorneys’ Fees. In any action to enforce the terms of this License or seeking damages relating thereto, the prevailing party shall be entitled to recover its costs and expenses, including, without limitation, reasonable attorneys' fees and costs incurred in connection with such action, including any appeal of such action. This section shall survive the termination of this License. 13) Miscellaneous. If any provision of this License is held to be unenforceable, such provision shall be reformed only to the extent necessary to make it enforceable. 14) Definition of "You" in This License. "You" throughout this License, whether in upper or lower case, means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License. For legal entities, "You" includes any entity that controls, is controlled by, or is under common control with you. For purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. 15) Right to Use. You may use the Original Work in all ways not otherwise restricted or conditioned by this License or by law, and Licensor promises not to interfere with or be responsible for such uses by You. 16) Modification of This License. This License is Copyright © 2005 Lawrence Rosen. Permission is granted to copy, distribute, or communicate this License without modification. Nothing in this License permits You to modify this License as applied to the Original Work or to Derivative Works. However, You may modify the text of this License and copy, distribute or communicate your modified version (the "Modified License") and apply it to other original works of authorship subject to the following conditions: (i) You may not indicate in any way that your Modified License is the "Academic Free License" or "AFL" and you may not use those names in the name of your Modified License; (ii) You must replace the notice specified in the first paragraph above with the notice "Licensed under <insert your license name here>" or with a notice of your own that is not confusingly similar to the notice in this License; and (iii) You may not claim that your original works are open source software unless your Modified License has been approved by Open Source Initiative (OSI) and You comply with its license review and certification process.

简介

card.js是一款绘制游戏王卡图的工具 展开 收起
JavaScript
AFL-3.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/SirWangCode/cardjs.git
git@gitee.com:SirWangCode/cardjs.git
SirWangCode
cardjs
cardjs
master

搜索帮助