(english)
Concluindo este tutorial você vai:
Dar opção de configurações para o seu mod através de arquivos .ini, ou armazenar valores dentro de arquivos .ini, escrevendo e lendo o que quiser, quando quiser.
A importância dos arquivos .ini
Muita gente que baixa mods, acha importante que o mod seja configurável em algum arquivo, para ajustar o mod ao agrado da pessoa (e evitar coisas do tipo
"ei, seu mod causa muito dano, eu queria algo com menos dano!").
E arquivos .ini são fáceis tanto para quem está criando o mod, quanto para quem está baixando e configurando: é um formato de arquivo extremamente simples que qualquer pessoa sabe mexer!
Código: Selecionar tudo
[Char]
SpawnDistance = 100.0
ModelName = MALE01
[Stats]
Money = 50
Exemplo de arquivo .ini:
Basicamente não há limites do tamanho do nome da section e key, mas para boas práticas e otimização, use nomes curtos (até uns 16 ou 20 caracteres está bom).
Escolha um bom nome de arquivo .ini, único, de preferência com o nome do seu mod (o mesmo nome do arquivo .cs).
Neste caso, eu estou usando "Example.ini".
Há um comando diferente para cada datatype:
Código: Selecionar tudo
READ_INT_FROM_INI_FILE "CLEO\Example.ini" "Section" "KeyInt" i
READ_FLOAT_FROM_INI_FILE "CLEO\Example.ini" "Section" "KeyFloat" f
READ_STRING_FROM_FILE "CLEO\Example.ini" "Section" "KeyString" t
E você também pode usar como condição, usando
IF:
Código: Selecionar tudo
SCRIPT_START
{
LVAR_INT i
IF NOT READ_INT_FROM_INI_FILE "CLEO\Example.ini" "Section" "KeyInt" i
i = -1
ENDIF
main_loop:
WAIT 0
PRINT_FORMATTED_NOW "Value is: %i" 1000 i
GOTO main_loop
}
SCRIPT_END
Neste caso eu usei
IF NOT para colocar um valor padrão caso o valor não seja lido — isto é, o arquivo .ini não existe, ou a section ou key não pôde ser encontrada.
E claro, eu realmente te recomendo usar string (
ponteiro de buffer) em vez de text label, para poder aceitar até 127 caracteres e usar somente 1 variável:
Código: Selecionar tudo
SCRIPT_START
{
LVAR_INT pBuffer
GET_LABEL_POINTER Buffer (pBuffer)
IF NOT READ_STRING_FROM_INI_FILE "CLEO\Example.ini" "Section" "KeyString" pBuffer
STRING_FORMAT pBuffer "fail"
ENDIF
main_loop:
WAIT 0
PRINT_FORMATTED_NOW "Value is: %s" 1000 $pBuffer
GOTO main_loop
}
SCRIPT_END
Buffer:
DUMP
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 //32
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 //64
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 //96
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 //128
ENDDUMP
Quase igual ao ler:
Código: Selecionar tudo
WRITE_INT_TO_INI_FILE 1 "CLEO\Example.ini" "Section" "KeyInt"
WRITE_FLOAT_TO_INI_FILE 1.0 "CLEO\Example.ini" "Section" "KeyFloat"
WRITE_STRING_TO_INI_FILE "One" "CLEO\Example.ini" "Section" "KeyString"
Este exemplo, irá gerar um arquivo .ini como visto antes:
Caso o arquivo não exista, será criado. Mas só funciona caso a pessoa não tenha proteções na pasta do jogo (por exemplo, o jogo seja instalado fora da "Arquivos de Programas"). Também pode ser usado com
IF.
Escrever algo em arquivos .ini não é uma prática comum (eu praticamente nunca usei).
Uma utilidade legal, é guardar informações ao salvar o jogo, usando
SET_SCRIPT_EVENT_SAVE_CONFIRMATION do
CLEO+.
Umas pessoas usam isso para criar um arquivo .ini completo caso o arquivo não exista instalado. Eu particularmente não gosto dessa prática, principalmente se o mod vem sem arquivo .ini e ele só é criado após abrir o jogo, há casos de uso, mas eu prefiro só colocar avisos na tela para a pessoa instalar.
Considerações importantes
Você pode pensar
"ok, super fácil, já posso começar a usar!",
não sem antes ter em mente os seguintes pontos:
ABSOLUTAMENTE NUNCA NA SUA VIDA LEIA OU ESCREVA UM ARQUIVO .INI EM LOOP CADA FRAME.
Mesmo que não cause perda de FPS no seu jogo, há alguns casos em que o FPS do jogo cai pela metade, e eu já vi muitos mods assim, é sério, você merece um tapa se fizer isso.
Somente trabalhe nos arquivos .ini logo no início do script, ou logo no momento que ativa o mod, nunca em loop.
Pro início do script eu recomendo usar dois
WAIT 0 pra pular o frame "falso" onde o jogo é reiniciado uma vez no primeiro load (nada importante, economiza uma minúscula fração do uso de disco).
Se você realmente precisa guardar muitas configurações e falta variáveis, leia o tutorial de
Script Memory, eu gosto de fazer isso junto com
offsets. No caso de opções "verdadeiro ou falso" (true/false), guarde em
bits, assim você consegue guardar 32 "true/false" em 1 só variável.
Cuidado com comentários!
Você pode (e deve) comentar as configurações, adicionando explicações:
Código: Selecionar tudo
; Mod Example
[Section]
KeyInt = 1 ; We are number one
KeyFloat = 1.0 ; We are number one with a decimal point
; We are number one, but in text now:
KeyString = One
Mas NUNCA faça isto:
Código: Selecionar tudo
[Section] ; This is a section AND I BROKE THE FILE NOW!!!!
KeyString = One ; We are number one, AND I BROKE IT AGAIN!!!!!!!!
Eu já quebrei muitas vezes os meus mods por causa disso.
Não importante, mas, comentários são definidos com
; não
# (eu usava errado antigamente). Usar
# funciona, mas o "parser" de arquivo não irá ignorar esses textos, o que é incorreto.
Cuidado com endereços!
O ModLoader só encontra o arquivo .ini caso ele esteja dentro de uma pasta "CLEO" dentro de uma pasta de mod.
Ou seja:
CLEO\Example.ini - Correto!
modloader\Mod\CLEO\Example.ini - Correto!
modloader\CLEO\Example.ini - Incorreto!
modloader\Mod\Example.ini - Incorreto!
Não só isto.
No meu jogo, funciona sem colocar "CLEO" no caminho no comando de ler/escrever o .ini, mas em outras pessoas isto não funciona. Eu não sei o motivo, mas eu já tive que repostar uns 5 mods por causa disso.
Ou seja:
READ_INT_FROM_INI_FILE "CLEO\Example.ini" "Section" "KeyInt" i - Correto!
READ_INT_FROM_INI_FILE "Example.ini" "Section" "KeyInt" i - Incorreto!
Bote a mão na massa!
Pegue qualquer script que você fez antes, e adapte qualquer coisa para usar algum valor de um arquivo .ini.
