Author

Xenocidius · « **on:** April 15, 2012, 12:17:48 pm »

Want to make an Elements tool but can't be bothered writing out all the different properties of every single card that you need? No problem! The Ultimate Elements PHP/Javascript Library is here to help for your client-side and server-side needs.

>> The Ultimate Elements PHP/Javascript Library <<

You can find the library here in text format. Simply change the file extension to .php, upload it to your server and access it like so in PHP:

Code: [Select]

require_once('elements_lib.php');
To use the library in Javascript, go to elements_lib.php?jsupdate. This will automatically create a file called elements_lib.js and populate it. You should do this whenever you update your library. Access it like so:

Code: [Select]

<script src='elements_lib.js'></script>
To change the path of the Javascript file to write to, find the variable $jsfile and change it. You can also have a dynamic Javascript file outputted by elements_lib.php?js. Note that the Javascript will automatically be compressed by JSCompress. To see the raw Javascript, add a nocompress parameter to the URL, as in elements_lib.php?js&nocompress.

Can't be bothered uploading it to your server? Want to try it out first? No problem!

PHP:

Code: [Select]

eval('?>' . file_get_contents('http://elementscommunity.org/tools/elements_lib.txt') . '<?php;');
Javascript:

Code: [Select]

<script src='http://elementscommunity.org/tools/elements_lib.js'></script>
You are free to use the library in any of your tools without credit, as long as the tool is exclusive to the Elements community. If you plan to use it somewhere else for whatever reason, mention my name and provide a link to this topic.

How to use the library

Before we use the library, we need to understand how the game and library stores and references cards. Basically, each element is given a number, like so:

Other: 0
Entropy: 1
Death: 2
Gravity: 3
Earth: 4
Life: 5
Fire: 6
Water: 7
Light: 8
Air: 9
Time: 10
Darkness: 11
Aether: 12

Yes, this is the order of elements in the deck building screen and Bazaar.

Each card is stored as a number too. This number for non-upgraded cards is equal to the number of the element multiplied by 100 plus an arbitrary number:

Code: [Select]

Card number = element number * 100 + x
x is 0 for pillars, 20 for nymphs and 50 for pendulums. For other cards, it is merely the order in which they were added to the game.

So, Amethyst Pillar is 100, Black Nymph is 1120, Heal is 506, etc. There is one exception to this pattern - Quantum Pillar is 2, not 0.

Upgraded cards are simply the non-upgraded card + 2000. So, Amethyst Pillar is 2100, Dark Nymph is 3120, Quantum Tower is 2002, etc.

The library uses a standard format for decks. Each deck is an array of these card numbers (2, 2002, 1450, etc.). They also have a 'mark' index which stores the element number of the deck's mark. Some decks also have a 'name' index.

Card Data

Now that that's out of the way, we can look at the main feature of the library, which is the array called $__cardData.

$__cardData is essentially an array of objects. Each object represents a card, and can be accessed by cardData(card number). For example, Amethyst Pillar's object is cardData(100).

Each card object has a number of different properties. Each object has the following properties:

name

The name of the card.

ctype

This can take upon one of the following values:

'creature' - Any creature except Chimera.
'spell' - All spells and Chimera.
'pillar' - All pillars, pendulums and marks.
'shard' - All permanent shards.
'weapon' - All weapons.
'shield' - All shields.
'permanent' - All other permanents.

atk

The ATK of a creature or damage a weapon deals. Set to 0 for everything else.

def

The HP of a creature, damage reduction of a shield or amount healed per turn by Purify. Set to 0 for everything else.

skill

The name of a card's skill.

Spoiler for List of skills:

skillcost

The cost of a skill. An empty string if the skill is not active and manually activated.

skillelement

The number of the element used to pay for a skill. Usually an empty string if the skill is not active and manually activated.

cost

The casting cost of a card.

costelement

The number of the element used to pay for a card. 0 if the card can be paid for with any quanta (Animate Weapon, etc.)

rarity

The 'tier' of a card, used in buying and selling cost calculations.

They may also have:

passive

The name of a card's passive skill.

Spoiler for List of all passives:

passive2

The name of a card's second passive skill. Right now this can only be 'airborne', or an empty string for weapons.

AI Decks

Getting random AI decks are made easy by this simple function:

array AIDeck(int $level, string $name = '')

Level is a number from 0 to 5, the AI level for which you want a deck to be generated. Name can be specified when level is 5 to get a specific False God deck.

One can also access the $AIDecks array, which stores AI2, AI3 and AI5 decks.

Functions

All these functions can be used the same way in both PHP and Javascript. Examples given are for PHP.

Spoiler for cardData:

Spoiler for getDeck:

Spoiler for outputDeck:

Spoiler for cards:

Spoiler for sortDeck:

Spoiler for deckSize:

Spoiler for fromElement:

Spoiler for toElement:

Spoiler for fromCardCode:

Spoiler for toCardCode:

Spoiler for fromMarkCode:

Spoiler for toMarkCode:

Spoiler for elementOf:

Spoiler for is_pillar:

Spoiler for is_pendulum:

Spoiler for is_nymph:

Spoiler for is_rare:

Spoiler for is_upgraded:

Spoiler for upgrade:

Spoiler for downgrade:

Spoiler for compressDeckCode:

Spoiler for decompressDeckCode:

Spoiler for cardImage:

Spoiler for deckImage:

Examples

Let's write a quick program to calculate the cost of a deck.

In PHP ($_GET['deck'] is the input):

<?php

Code: [Select]

require_once("elements_lib.php");

$deck = getDeck($_GET['deck']);
$cost = 0;

function buy_price($card) {
	return 6 * pow(cardData($card)->rarity, 2) + cardData($card)->cost;
}

foreach (cards($deck) as $card) {
	$cost += buy_price($card);
}

echo "Cost of deck: " . $cost;

?>

That was easy, wasn't it? Let's try the same thing in Javascript:

Code: [Select]

<script src='elements_lib.js'></script>
<script>
deck = getDeck(prompt("Enter a deck code"));
cost = 0;

function buy_price(card) {
	return 6 * Math.pow(cardData(card).rarity, 2) + cardData(card).cost;
}

for (i in cards(deck)) {
	cost += buy_price(deck[i]);
}

alert("Cost of deck: " + cost);
</script>

This is just the tip of the iceberg. The library can be used and extended to fit virtually any needs you may have for your tool. Now get coding!

euclid47 · « **Reply #1 on:** April 25, 2012, 09:58:47 pm »

This is some great work! Wow! I will try to port the code over to .Net and open source.

Rutarete · « **Reply #2 on:** April 25, 2012, 10:02:40 pm »

THis looks fun! hehe, what should I do first?

Drake_XIV · « **Reply #3 on:** April 25, 2012, 10:11:04 pm »

Marking for future use

The_Mormegil · « **Reply #4 on:** April 26, 2012, 06:36:05 am »

I don't think I gave you enough Karma recently.

eaglgenes101 · « **Reply #5 on:** August 17, 2012, 06:59:53 pm »

*Cough* Javascript under my belt. Now I'll see if I can make use of it.

EDIT: Please explain.

eaglgenes101 · « **Reply #6 on:** August 27, 2012, 05:43:31 am »

How do I get the JS part?

ARTHANASIOS · « **Reply #7 on:** September 28, 2012, 02:39:36 pm »

Quote from: eaglgenes101 on August 27, 2012, 05:43:31 am

How do I get the JS part?

Here is a Javascript tutorial. I study it too.

http://www.w3schools.com/js/default.asp

russianspy1234 · « **Reply #8 on:** September 28, 2012, 03:48:40 pm »

Now to try and make a random card generator...

eaglgenes101 · « **Reply #9 on:** September 29, 2012, 05:34:41 am »

Quote from: Xenocidius on April 15, 2012, 12:17:48 pm

To use the library in Javascript, go to elements_lib.php?jsupdate. This will automatically create a file called elements_lib.js and populate it. You should do this whenever you update your library. Access it like so:

Code: [Select]
<script src='elements_lib.js'></script>
To change the path of the Javascript file to write to, find the variable $jsfile and change it. You can also have a dynamic Javascript file outputted by elements_lib.php?js. Note that the Javascript will automatically be compressed by JSCompress. To see the raw Javascript, add a nocompress parameter to the URL, as in elements_lib.php?js&nocompress.

Can someone detail this further so I can use it on my own computer? Where do I enter the part referred to by elements_lib.php?jsupdate? Command Prompt?

Pineapple · « **Reply #10 on:** January 04, 2013, 09:22:29 am »

Okay, so I made a function in python that reads the "elements_lib.txt" file (assuming it is in the same directory as the script) and returns a 2D dictionary (well, one dictionary nested within another) of the card database.
It's rather crude and poorly commented, but I thought I'd share it nonetheless.
It's the best thing you could have until someone does that php-to-python library conversion

Code: [Select]

import sys,os
phplib=open(os.path.join(sys.path[0], "elements_lib.txt"), "r")

def setCardData():
        cardData=dict()
        index=0
        for line in phplib:
                if line[ :7]=='//Decks': return cardData
                if line[len(line)-2: ]=='(\n':
                        while not str(index) in line:
                                index+=1
                        cardData[index]=dict()
                elif line[ :2]=='\t\'':
                        key_val=line[2:len(line)-2].split('\' => ')  #'key'=>'val' to key_val=[key,'val]
                        key_val=line[2:len(line)-2].split('\' =>')  #for exceptions (Colossal Dragon)
                        key=key_val[0]; val=key_val[1]
                        if key=='def': key='hp'  #def Python keyword; replaced with hp
                        val=val[1: ] #trimming ''val' to 'val'
                        try: int(val)
                        except ValueError: val=val[1:len(val)-1]  #trimming ''string'' to 'string'
                        cardData[index][key]=val

So:

Quote

>>>print setCardData()[2406]

Gives the following output:

Quote

{'name': 'Shard of Freedom', 'skillelement': 6, 'atk': 0, 'ctype': 'shard', 'rarity': 18, 'cost': 3, 'costelement': 0, 'skillcost': '', 'skill': 'freedom', 'def': 0}

Pineapple · « **Reply #11 on:** January 08, 2013, 11:09:48 am »

Okay, I finished translating many of the functions into python. There are plenty of differences, for example two new functions (set/get custom card), a few name/functionality changes, and most data stored in arrays are stored in dictionaries instead. I also changed some of the program logic if I thought there was a more pythonic alternative. Perhaps I should put together a small list of all the changes..

Below is the script. If you run the script, you'll be stuck in the "test loop" where you can type any of the functions to have its return value printed into the console.

Spoiler for Hidden:

Code: [Select]

import sys
import os
import re
import string

# Adapted from 'Elements Library by Xenocidius - version 1.31'

def getDefaultCardData(): #returns cardData array from elements_lib.txt as a dict
        phplib=open(os.path.join(sys.path[0], "elements_lib.txt"), "r")
	cardData=dict()
	index=0
	for line in phplib:
		if line[ :7]=='//Decks': return cardData
		if line[len(line)-2: ]=='(\n':
			while not str(index) in line:
				index+=1
			cardData[index]=dict()
		elif line[ :2]=='\t\'':
			key_val=line[2:len(line)-2].split('\' => ')  #'key'=>'val' to key_val=[key,'val]
			key_val=line[2:len(line)-2].split('\' =>')  #for exceptions (Colossal Dragon)
			key=key_val[0]; val=key_val[1]
			if key=='def': key='hp'  #def Python keyword; replaced with hp
			val=val[1: ] #trimming ''val' to 'val'
			try: int(val)
			except ValueError: val=val[1:len(val)-1]  #trimming ''string'' to 'string'
			cardData[index][key]=val

def getDefaultElements():
	return ('Other','Entropy','Death','Gravity','Earth','Life','Fire',
		'Water','Light','Air','Time','Darkness','Aether')

def getCardData(card=False): #originally cardData()
	global cardData
	if card:
		if card<=3300:
			try:
				return cardData[card]
			except KeyError:
				showError("Card number "+str(card)+"does not exist!")
		else:
			return getCustomCardData(card-3300)
	else:
		return cardData
		
	
def getCustomCardData(card=False):
	global customCardData
	if card:
		try:
			return customCardData[card]
		except KeyError:
			showError("Card number "+str(card+3300)+" does not exist!")
	else:
		return customCardData

def setCustomCardData(
		card=False, data=False, name=False, ctype='empty',
		atk=0, hp=0, skill='', skillcost='', skillelement=0,
		cost=0, costelement=0, rarity=0, passive=False, passive2=False):
	global customCardData
	if not card:
		i=0
		while i in customCardData.keys(): i+=1
		card=i
	if not card in customCardData:
		if name:
			customCardData[card]={'name':name}
		else:
			customCardData[card]={'name':'Custom'+str(card)}
	if data:
		try: customCardData[card]=dict(data)
		except ValueError,e: showError("ValueError: "+e)
		return
	details={'ctype':ctype, 'atk':atk, 'hp':hp,
		'skill':skill, 'skillcost':skillcost, 'skillelement':skillelement,
		'cost':cost, 'costelement':costelement, 'rarity':rarity,
		'passive':passive, 'passive2':passive2}
	for key in details:
		if str(details[key])!=str(False):
			customCardData[card][key]=details[key]
	return ''

def toDeck(deckCode): #originally getDeck, returns card numbers and mark from deck code
	deckMark=False
	deckCards=list()
	ex=deckCode.split(' ')
	for current in ex:
		mark=fromMarkCode(current)
		if mark:
			deckMark=markCode
		else:
			card=fromCardCode(current)
			if card:
				i=0
				while i in deck: i+=1
				deckCards.append(card)
			else:
				return showError("Invalid deck code!")
	deck=dict(deckCards.sort())
	deck['mark']=deckMark
	return deck

def toDeckCode(deck): #originally outputDeck(), returns deck code from card numbers
	deckCode_list=[]
	for card in cardsOf(deck):
		deckCode_list.append(toCardCode(card))
	try:
		deck['mark']
		deckCode_list.append(toMarkCode(deck['mark']))
	except KeyError:
		pass
	return ' '.join(deckCode_list)

def cardsOf(deck): #originally cards()
	cards=[]
	for key,card in deck.items():
		try: int(key); cards.append(card)
		except ValueError: pass
	return cards

def getDeckSize(deck): #originally deckSize()
	return len(cardsOf(deck))

def fromElement(element_number):  #returns name of element from its number
	global elements
	try:
		return elements[element_number]
	except IndexError:
		return 'Other'
		
def toElement(element):  #returns element number from its name
	global elements
	try:
		return elements.index(element)
	except ValueError:
		return 0

def base10to32(num):  #converts from a base10 int to a base32 str with lowercase letters
        base10to32.output=[]
        numerals=string.digits+string.lowercase
        def remLoop(num):  #remainder method of base conversion
                q_r=divmod(num,32)
                base10to32.output.append(numerals[q_r[1]])
                if q_r[0]==0:
                        return
                else:
                        remLoop(q_r[0])
        remLoop(num)
        base10to32.output.reverse()
        return ''.join(base10to32.output)

def fromCardCode(cardCode):  #returns card number from its card code
	if len(cardCode)!=3 or re.search('[^a-v0-9]',cardCode)!=None:
		return False
	return int(cardCode,32)-5000

def toCardCode(card):  #returns card code from its card number
	return base10to32(card+5000)

def fromMarkCode(markCode):  #returns element number from its mark code
	element = fromCardCode(markCode) - 4010
	global elements
	try:
		elements[element]
		return element
	except KeyError:
		return False

def toMarkCode(element):  #returns mark code from its element number
	try:
		elements[element]
		return toCardCode(element+4010)
	except KeyError:
		return False

def elementOf(card):  #returns element number of a card from its card number
	return int(downgrade(card)/100)

def is_upgraded(card):  #returns whether a card is upgraded from its card number
	return card>2000

def upgrade(card):  #returns the upgraded version of a card from its card number
	if is_upgraded(card):
		card+=2000
	return card

def downgrade(card): #returns the downgraded version of a card from its card number
	if not is_upgraded(card):
		card-=2000
	return card

def compressDeckCode(deck):
	numerals=string.digits+string.uppercase+string.lowercase
	deck=deck.split(' ')
	cards={}
	output=[]
	for card in deck:
		try:
			cards[card]+=1
		except KeyError:
			cards[card]=0
	for card,occurences in cards.items():
		if occurences>0:
			output.append('z'+numerals[occurences])
		output.append(card)
	return ''.join(output)

def decompressDeckCode(deck):
	numerals=string.digits+string.uppercase+string.lowercase
	i=0
	cards={}
	output=[]
	while(i<len(deck)):
		if deck[i]=='z':
			cards[deck[i+2:i+5]]=numerals.index(deck[i+1])
			i+=5
		else:
			cards[deck[i:i+3]]=0
			i+=3
	for card,occurences in cards.items():
		output.append(card)
		for i in xrange(occurences):
			output.append(card)
	return ' '.join(output)
		

def showError(msg):
	print msg

#load global variables
cardData=getDefaultCardData()
customCardData=dict()
elements=getDefaultElements()

#test loop
while 1:
	print input("Command?\n")

Author

Xenocidius

The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg481488#msg481488

euclid47

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg487427#msg487427

Rutarete

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg487430#msg487430

Drake_XIV

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg487434#msg487434

The_Mormegil

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg487694#msg487694

eaglgenes101

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg534253#msg534253

eaglgenes101

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg536928#msg536928

ARTHANASIOS

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg1003405#msg1003405

russianspy1234

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg1003418#msg1003418

eaglgenes101

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg1003633#msg1003633

Pineapple

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg1028317#msg1028317

Pineapple

Re: The Ultimate Elements PHP/Javascript Library https://elementscommunity.org/forum/index.php?topic=38705.msg1029831#msg1029831