Configuração
Conheça as várias opções de configuração.
O plugin deve funcionar sem necessidade de configuração adicional, mas se você precisar alterar o comportamento do plugin, você está no lugar certo.
Após alterar a configuração, é necessário reiniciar o servidor.
Estrutura de arquivos
Abaixo está um exemplo de como é a estrutura de arquivos do plugin. Clique em uma pasta para expandi-la.
Como funciona
Antes de configurar, entenda como os valores de um investimento são calculados:
- Retorno efetivo:
base-return-percentdo ativo ×return-multiplierdo risco. - Multiplicador do ativo: multiplicador do mercado (que oscila sozinho) × multiplicador do evento ativo (se houver).
- Valor atual: valor aplicado × (1 + retorno efetivo × progresso) × multiplicador do ativo, onde o progresso vai de 0 a 1 até o vencimento.
- Total debitado ao investir: valor aplicado + taxa de entrada.
- Resgate antecipado: valor atual − taxa de saída (calculada sobre o valor atual).
Exemplo: investindo 1.000 no CDB (base-return-percent: 5.0, risco LOW com return-multiplier: 0.7), o retorno efetivo é de 3,5%. Com o mercado em 1.00x, o retorno estimado ao vencer é de 1.035. A taxa de entrada de 1% faz o total debitado ser de 1.010.
Configuração do plugin (config.yml)
O arquivo config.yml controla o banco de dados, o mercado, os eventos, as restrições de uso e os formatos exibidos. Abaixo estão todas as opções disponíveis com explicações detalhadas.
debug-mode
Ativa ou desativa o modo de depuração. Quando ativado, o plugin registrará informações detalhadas no console para ajudar a identificar problemas.
# Modo de depuração para correção de problemas no plugin.
debug-mode: falseMantenha desativado em produção, pois pode gerar muitos logs e afetar a performance.
database
Configurações do banco de dados onde ficam salvos os jogadores e os investimentos.
database:
# Determina o tipo de banco de dados. Valores válidos: [SQLITE, MYSQL, HIKARI (recomendado)]
storage-type: SQLITE
# Dados para conexão ao banco de dados MYSQL.
data:
# Endereço de conexão do banco de dados. [EX: 127.0.0.1]
host: localhost
# Porta de conexão do banco de dados. [EX: 3306]
port: 3306
# Nome do banco de dados a ser conectado. [EX: minecraft]
database: ''
# Usuário de conexão. [EX: root]
username: ''
# Senha do usuário de conexão: [EX: 123]
password: ''- storage-type:
SQLITEsalva em arquivo local;MYSQLeHIKARIusam os dados de conexão emdata.
redis
Configurações do servidor Redis, usado para sincronizar os dados entre servidores.
# Configurações do servidor redis
redis:
# Ativar a conexão com o redis
enabled: false
# Endereço de conexão. [EX: 127.0.0.1]
host: 'localhost'
# Porta de conexão. [EX: 3306]
port: 6379
# Usuário de conexão. [EX: root]
username: ''
# Senha do usuário de conexão: [EX: 123]
password: ''login-delay
Delay, em ticks, para carregar os dados do jogador depois do login.
# Delay para carregar os dados depois do login
# Necessário para usar em servidor de mina separado
# Recomendado: 20 ticks
login-delay: 20Necessário quando o plugin é usado em um servidor de mina separado. O recomendado é 20 ticks (1 segundo).
general
Configurações gerais do sistema de investimentos.
Limites e intervalos
general:
# Máximo de investimentos ativos simultâneos por jogador (sem permissão yinvestimento.slots.N)
max-active-default: 5
# Intervalo (em ticks) para verificar vencimentos (200 ticks = 10 segundos)
maturity-check-interval-ticks: 200
# Intervalo (em ticks) para cobrar taxa de manutenção dos ativos
maintenance-interval-ticks: 6000- max-active-default: quantidade máxima de investimentos ativos ao mesmo tempo para jogadores sem a permissão
yinvestimento.slots.<N>. - maturity-check-interval-ticks: de quanto em quanto tempo o plugin verifica se algum investimento venceu.
- maintenance-interval-ticks: de quanto em quanto tempo a taxa de manutenção (
maintenance-fee-percentdo ativo) é cobrada. Se o jogador não tiver saldo, recebe a mensagemmaintenance-fail.
amount-presets
Valores pré-definidos exibidos no menu de seleção de valor. O jogador também pode digitar um valor personalizado no chat.
# Valores pré-definidos exibidos no menu de valor. [EX: 1000.0 = 1K]
amount-presets:
- 1000.0
- 5000.0
- 10000.0
- 25000.0
- 50000.0
- 100000.0market
Oscilação automática do mercado. A cada intervalo, o multiplicador de cada ativo sobe ou desce aleatoriamente de acordo com a volatilidade do ativo, sempre respeitando o mínimo e o máximo.
# Oscilação automática do mercado (bolsa de valores)
market:
# Intervalo (em ticks) da oscilação de cada ativo (200 ticks = 10 segundos)
tick-interval-ticks: 200
# Multiplicador mínimo permitido no mercado. [EX: 0.4 = 40% do valor]
min-multiplier: 0.4
# Multiplicador máximo permitido no mercado. [EX: 1.8 = 180% do valor]
max-multiplier: 1.8
# Quantidade de pontos armazenados no gráfico de histórico
history-size: 20Exemplo: com min-multiplier: 0.4 e max-multiplier: 1.8, um ativo nunca fica abaixo de 0.40x nem acima de 1.80x, inclusive ao usar /investimento mercado.
events
Eventos econômicos aleatórios, configurados na pasta events/. Veja Eventos.
# Eventos econômicos aleatórios (arquivos em plugins/yInvestimento/events/)
events:
# Se true, o plugin tenta disparar eventos no intervalo abaixo
enabled: true
# Intervalo (em ticks) para tentar disparar um evento (1200 = 60 segundos)
check-interval-ticks: 1200- enabled: se
true, a cadacheck-interval-tickso plugin tenta disparar um evento de acordo com achancede cada um.
worlds
Controla em quais mundos o sistema de investimentos pode ser usado.
# Controle de mundos em que o sistema pode ser usado
worlds:
# Se enabled: true, o sistema só funciona nos mundos listados
white-list:
enabled: false
list: []
# Mundos bloqueados mesmo com a whitelist desativada. [EX: world_nether]
black-list: []Exemplo: para liberar o sistema apenas no mundo spawn:
worlds:
white-list:
enabled: true
list:
- spawn
black-list: []regions
Controla em quais regiões do WorldGuard o sistema pode ser usado.
# Controle de regiões do WorldGuard em que o sistema pode ser usado
regions:
# Se enabled: true, o jogador precisa estar em uma das regiões listadas
white-list:
enabled: false
list: []
# Regiões bloqueadas mesmo com a whitelist desativada
black-list: []Requer o WorldGuard instalado.
progress-bar
Barra de progresso exibida na carteira (placeholder {bar}), representando o tempo restante do investimento.
# Barra de progresso exibida na carteira (tempo restante do investimento)
progress-bar:
filled: '&a█'
empty: '&7█'
length: 20graph
Caracteres do gráfico de mercado (placeholder {graph}), exibido no detalhe do ativo e no relatório.
# Caracteres do gráfico de mercado (up = alta, mid = estável, down = baixa)
graph:
up: '&a█'
mid: '&e█'
down: '&c█'
length: 20- up: oscilação de alta.
- mid: oscilação estável.
- down: oscilação de baixa.
sounds
Sons reproduzidos nas ações do plugin. Use nomes do enum Sound do Bukkit.
# Sons reproduzidos nas ações do plugin (nomes do enum Sound do Bukkit)
sounds:
invest-success: 'ENTITY_EXPERIENCE_ORB_PICKUP'
invest-fail: 'ENTITY_VILLAGER_NO'
collect: 'ENTITY_PLAYER_LEVELUP'
withdraw: 'ENTITY_ITEM_BREAK'
event: 'ENTITY_LIGHTNING_THUNDER'
matured: 'ENTITY_FIREWORK_ROCKET_LAUNCH'status
Formatos exibidos para o status de cada investimento (placeholder {status}).
# Sistema de formatos de status
status:
active: '&aAtivo'
completed: '&eVencido'
withdrawn: '&cResgatado'
collected: '&2Coletado'- active: investimento em andamento.
- completed: investimento vencido, aguardando coleta.
- withdrawn: investimento resgatado antecipadamente.
- collected: retorno já coletado.
risk
Classificação de risco usada nos arquivos de ativo (risk: LOW, MEDIUM ou HIGH). Cada risco ajusta o retorno e a volatilidade do ativo.
# Classificação de risco (retorno e volatilidade proporcionais ao ativo)
# Valores válidos nos arquivos de ativo: [LOW, MEDIUM, HIGH]
risk:
low:
# Texto colorido exibido nos menus e mensagens
display: '&aBaixo'
# Multiplicador aplicado sobre o retorno base do ativo
return-multiplier: 0.7
# Multiplicador aplicado sobre a volatilidade do ativo
volatility-multiplier: 0.4
medium:
display: '&eMédio'
return-multiplier: 1.0
volatility-multiplier: 1.0
high:
display: '&cAlto'
return-multiplier: 1.6
volatility-multiplier: 1.8Exemplo: o ativo Fundos tem base-return-percent: 25.0 e volatility: 0.08 com risco HIGH. O retorno efetivo fica em 40% (25 × 1.6) e a volatilidade em 14,4% por oscilação (0.08 × 1.8).