天狼星附属开发教程 - 编程开发

萝娜娜

本帖最后由萝娜娜于 2021-5-25 00:22 编辑

「天狼星」附属开发教程

简介:
天狼星有CommonAPI,ServerAPI,ClientAPI三个API，其中CommonAPI在服务端和客户端都可使用，ClientAPI仅能在客户端使用，ServerAPI仅能在服务端使用。
CommonAPI:
EventBusManager--事件总线管理器，通过该类可以获取天狼星默认使用的事件总线或者用来创建自定义的事件总线。
Logger--天狼星的日志类，通过该类可以向客户端|服务端进行日志记录
ResourceManager--资源管理器，通过该类可以获取天狼星资源包内的资源（不可获取MC资源包的资源）
Scheduler
ClientAPI:
anticheat--天狼星反作弊
ClientNetworkManager--客户端网络管理器，通过该类可以自定义客户端连接服务器的方式（天狼星KCP加速则是由该类实现）
hwinfo--硬件信息，共可采集48项客户端计算机信息（主板 CPU 内存条显卡硬盘等），也可获得客户端硬件码
input--键鼠输入
model--模型绘制
multimedia--音视频解码与编码
renderer--底层renderer
vanilla--mc原版相关功能
widgets--天狼星WidgetsUI库
imgui--天狼星ImGui库
ServerAPI:
network--客户端通信相关
game.event--游戏事件相关

例子项目

服务端附属

客户端附属

客户端的附属放置于.minecraft/config/Sirius/plugins/
服务端的附属放置于plugins/Sirius/plugins/

开发者通过以上2个项目可以了解到如何完全基于天狼星进行UI设计音视频解码通信

客户端附属开发教程

首先假设读者已具有Bukkit插件开发的基础知识。
本教程以客户端附属例子为基础对天狼星api进行基本的介绍。
客户端附属简介：天狼星客户端附属会直接运行在玩家的电脑上，纯调用天狼星api的客户端附属可以直接在各个客户端版本中直接使用，无需移植。
一插件基类

二.事件

三.ImGui库的使用

本例子将拦截背包打开事件，并且打开一个自定义的界面
1.监听Gui打开事件

@EventHandler
public void onVanillaGuiOpenEvent(VanillaGuiOpenEvent vanillaGuiOpenEvent)

复制代码

2.检查打开的Gui是否为背包

if (vanillaGuiOpenEvent.getType() == GuiType.INVENTORY)

复制代码

3.阻止原版的打开事件

vanillaGuiOpenEvent.setCanceled(true);

复制代码

4.在2个时间单位后打开一个Sceen

CommonServices.getScheduler().addTaskLater(() -> {
val imGuiAPI = ImGuiServices.getImGuiAPI();//获取API
imGuiAPI.openScreen("sirius", "plugin example", new ImGuiRender() {//打开Screen
float value = 0.0f;//进度值
{
new Timer().scheduleAtFixedRate(new TimerTask() {
@Override
public void run() {
value = value > 100.0f ? 0 : value + 1.0f;
}
}, 100, 100);
}
@Override
public void render(ImGuiRenderEntry imGuiRenderEntry) {
val resource = ClientVanillaServices.getVanillaResourceManager().getResource("sirius", "textures/gui/sirius.png").get();//获取MC资源管理器的资源
val textureUtil = ClientServices.getTextureUtil();
val texture = textureUtil.loadTexture(resource.getInputStream()).get();//载入纹理
val textureUVMap = textureUtil.newTextureUVMap(texture, 0, 0, texture.getSize().x, texture.getSize().y);//新建贴图
imGuiRenderEntry.begin(new Consumer<ImGui>() {
@Override
public void accept(ImGui imGui) {
imGui.text(100, 200, "你好天狼星");//画一串字
imGui.image(400, 500, 200, 200, textureUVMap);//画图片
//画4个不同方向的进度条
imGui.progressBar(200, 200, 100, 50, value, 0xff882288, ImDirection.LEFT_TO_RIGHT);
imGui.progressBar(300, 200, 100, 50, value, 0xff882288, ImDirection.RIGHT_TO_LEFT);
imGui.progressBar(400, 200, 100, 50, value, 0xff882288, ImDirection.TOP_TO_BOTTOM);
imGui.progressBar(500, 200, 100, 50, value, 0xff882288, ImDirection.BOTTOM_TO_TOP);
}
});
}
@Override
public void onClose() {
logger.info("自定义Inventory关闭");
}
});
}, 2);

复制代码

四天狼星多媒体库

五与服务端通信

完整代码

package com.lonacloud.sirius.plugin.test;
import com.lonacloud.sirius.client.api.ClientServices;
import com.lonacloud.sirius.client.api.imgui.*;
import com.lonacloud.sirius.client.api.vanilla.ClientVanillaServices;
import com.lonacloud.sirius.client.api.vanilla.event.JoinServerEvent;
import com.lonacloud.sirius.client.api.vanilla.event.gui.GuiType;
import com.lonacloud.sirius.client.api.vanilla.event.gui.VanillaGuiOpenEvent;
import com.lonacloud.sirius.common.api.CommonServices;
import com.lonacloud.sirius.common.api.eventbus.EventHandler;
import com.lonacloud.sirius.common.api.log.Logger;
import com.lonacloud.sirius.common.api.network.Channel;
import com.lonacloud.sirius.common.api.plugin.SiriusPlugin;
import lombok.val;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Timer;
import java.util.TimerTask;
import java.util.function.Consumer;
/**
* @author lona, [email protected]
* @version 1.0
**/
public class TestPlugin extends SiriusPlugin {
private static final String domain = "ExamplePlugin";
private static final String name = "main";
private Logger logger;
private Channel channel;
@Override
public void onLoad() {
getLogger().info("onLoad");
}
@Override
public void onEnable() {
getLogger().info("onEnable");
logger = CommonServices.getLogger().getModuleLogger("SiriusPluginExample");//获取Logger
CommonServices.getEventBusManager().getDefaultEventBus().register(getPluginInfo().getName(), this);//注册事件监听器
channel = ClientServices.getNetworkManager().getChannel(domain, name);
getLogger().info("注册事件监听器完成");
}
@EventHandler
public void onJoinServer(JoinServerEvent event) {
CommonServices.getScheduler().addTaskLater(() -> {
String str = new String("你好天狼星");
val bytes = str.getBytes(StandardCharsets.UTF_8);
channel.send(bytes, 0, bytes.length);
}, 60);
}
@EventHandler
public void onVanillaGuiOpenEvent(VanillaGuiOpenEvent vanillaGuiOpenEvent) throws IOException {
if (vanillaGuiOpenEvent.getType() == GuiType.INVENTORY) {//检测游戏内是否背包被打开
vanillaGuiOpenEvent.setCanceled(true);//阻止原版背包打开
CommonServices.getScheduler().addTaskLater(() -> {
val imGuiAPI = ImGuiServices.getImGuiAPI();//获取API
imGuiAPI.openScreen("sirius", "plugin example", new ImGuiRender() {//打开Screen
float value = 0.0f;//进度值
{
new Timer().scheduleAtFixedRate(new TimerTask() {
@Override
public void run() {
value = value > 100.0f ? 0 : value + 1.0f;
}
}, 100, 100);
}
@Override
public void render(ImGuiRenderEntry imGuiRenderEntry) {
val resource = ClientVanillaServices.getVanillaResourceManager().getResource("sirius", "textures/gui/sirius.png").get();//获取MC资源管理器的资源
val textureUtil = ClientServices.getTextureUtil();
val texture = textureUtil.loadTexture(resource.getInputStream()).get();//载入纹理
val textureUVMap = textureUtil.newTextureUVMap(texture, 0, 0, texture.getSize().x, texture.getSize().y);//新建贴图
imGuiRenderEntry.begin(new Consumer<ImGui>() {
@Override
public void accept(ImGui imGui) {
imGui.text(100, 200, "你好天狼星");//画一串字
imGui.image(400, 500, 200, 200, textureUVMap);//画图片
//画4个不同方向的进度条
imGui.progressBar(200, 200, 100, 50, value, 0xff882288, ImDirection.LEFT_TO_RIGHT);
imGui.progressBar(300, 200, 100, 50, value, 0xff882288, ImDirection.RIGHT_TO_LEFT);
imGui.progressBar(400, 200, 100, 50, value, 0xff882288, ImDirection.TOP_TO_BOTTOM);
imGui.progressBar(500, 200, 100, 50, value, 0xff882288, ImDirection.BOTTOM_TO_TOP);
}
});
}
@Override
public void onClose() {
logger.info("自定义Inventory关闭");
}
});
}, 2);
//以下被注释的部分为另一个名为Widgets的UI库
// val container = new SFixed();
// val resource = ClientVanillaServices.getVanillaResourceManager().getResource("sirius", "textures/gui/sirius.png").get();
// try (val inputStream = resource.getInputStream()) {
// BufferedImage image = ImageIO.read(inputStream);
// val texture = ClientServices.getTextureUtil().loadTexture(image);
// val textureUtil = ClientServices.getTextureUtil();
// val tuvMap = textureUtil.newTextureUVMap(texture, 0, 0, texture.getSize().x, texture.getSize().y);
// val sImage = new SImage(new SVec2f(384, 216), tuvMap);
// val videoResource = ClientVanillaServices.getVanillaResourceManager().getResource("sirius", "video/test.flv");
// val videoAttach = new VideoAttach(sImage.getImage().getTexture(), videoResource.get());
// CommonServices.getScheduler().addTaskAsync(videoAttach::attachVideoBuffer);
// val sLabel = new SLabel("你好天狼星", 9999, 0xffffffff, 18, "dk");
// container.addComponent(new SLabel("天狼星Label", 9999, 0xffffffff, 18, "dk"), new SVec2f(300, 200));
// container.addComponent(new SPushButton(sImage, sLabel), new SVec2f(600, 300));
// container.addComponent(new SHoverText(new SVec2f(200, 400), Arrays.asList(new String[]{"你好", "hovertext"})), new SVec2f(200, 300));
// container.setCloseCallback(() -> videoAttach.setClosed(true));
// }
// vanillaGuiOpenEvent.setGui(new SWidgetGui() {
// private Container<?> iContainer = container;
//
// @Override
// public Container<?> getContainer() {
// return iContainer;
// }
//
// @Override
// public void setContainer(Container<?> container) {
// this.iContainer = container;
// }
//
// @Override
// public void draw() {
// try {
// IContainerRendererManager containerRendererManager = SWidgetServices.getContainerRendererManager();
// containerRendererManager.render(this.iContainer, 0.0F, 0.0F);
// } catch (Exception var2) {
// }
// }
// });
}
}
@Override
public void onDisable() {
getLogger().info("onDisable");
getLogger().info("on %s %s", "onDisable", "onDisable");
}
}

复制代码

资源

天狼星CommonAPIJavaDoc
天狼星ClientAPIJavaDoc
天狼星ServerAPIJavaDoc
注意服务器迁移，最近一周相关文档均不可用

慕柚.

这个还不错

whatfilmae

这教程好棒！

wshycaa

资源还没有发布吧？没找到MOD

萝娜娜

wshycaa 发表于 2021-4-16 14:49
资源还没有发布吧？没找到MOD

mod发了，但是考虑到有一个用来采集系统信息生成硬件码的api可能会违反版规所以没发到mcbbs

wshycaa

萝娜娜发表于 2021-4-16 15:17
mod发了，但是考虑到有一个用来采集系统信息生成硬件码的api可能会违反版规所以没发到mcbbs ...

从哪可以找到资源呢？我看了几个天狼星的帖子好像只有教程……

萝娜娜

wshycaa 发表于 2021-4-16 16:47
从哪可以找到资源呢？我看了几个天狼星的帖子好像只有教程……

https://sirius.stardreamstudio.com/files/

wshycaa

萝娜娜发表于 2021-4-16 18:03
https://sirius.stardreamstudio.com/files/

好的，谢谢，我去看看

xingyu

关注大佬了！qwq

幽心x

资源还没有发布吧？没找到MOD

熯楉

希望推出更多星系系列的开发教程！！！！！

James_XL

萝娜娜发表于 2021-4-16 18:03
https://sirius.stardreamstudio.com/files/

然而网站建设中...
而且点开plugins目录网页就炸了

想牵着你的手丶

学废了。。

想牵着你的手丶

up讲得好啊