यह लाइब्रेरी Verlihub हब के लिए लिखी गई Lua स्क्रिप्ट एकत्र करती है। प्रत्येक स्क्रिप्ट Verlihub C++ स्रोत को बदले या कस्टम प्लगइन संकलित किए बिना एक छोटा हब फीचर जोड़ती है।
डिस्प्ले बॉट, हेल्पर कमांड, समयबद्ध संदेश, उपयोगकर्ता-सूची प्रविष्टियाँ, सत्यापन सहायक और छोटे स्वचालन के लिए इन लेखों का उपयोग करें। हब प्रक्रिया के बाहर भारी काम रखें और Lua का उपयोग केवल हब व्यवहार के लिए करें जो Verlihub के अंदर चलना चाहिए।
इस पुस्तकालय का उद्देश्य
लाइब्रेरी मौजूद है इसलिए हब मालिक एक स्क्रिप्ट की समीक्षा कर सकता है, समझ सकता है कि यह क्या बदलता है, इसे अपेक्षित निर्देशिका में कॉपी कर सकता है, दस्तावेज़ सेटिंग्स को समायोजित कर सकता है, इसे लोड कर सकता है, इसका परीक्षण कर सकता है और बिना किसी अनुमान के इसे फिर से अक्षम कर सकता है।
प्रत्येक स्क्रिप्ट लेख में यह लिखा होना चाहिए:
- स्क्रिप्ट क्या करती है.
- Verlihub कौन सा फीचर बदलता है या जोड़ता है।
- चाहे वह बॉट, कमांड, टाइमर, हुक, उपयोगकर्ता-सूची प्रविष्टि, या सत्यापन सहायक बनाता हो।
- जहां स्क्रिप्ट फ़ाइल रखी जानी चाहिए.
- स्क्रिप्ट को कैसे लोड किया जाता है, पुनः लोड किया जाता है, अनलोड किया जाता है या अक्षम किया जाता है।
- कौन सी सेटिंग्स संपादित करना सुरक्षित है.
- स्क्रिप्ट किस Verlihub प्लगइन या हब अनुमति पर निर्भर करती है।
- ज्ञात सीमाएँ, संस्करण नोट्स और उत्पादन चेतावनियाँ।
अनुशंसित स्क्रिप्ट मानक
इस लाइब्रेरी में स्क्रिप्ट छोटी, पढ़ने योग्य और संस्करण नियंत्रित होनी चाहिए। एक Lua फ़ाइल को एक काम करना चाहिए। क्लॉक बॉट, रूल्स कमांड, एंटी-स्पैम चेक और डेटाबेस क्लीनअप को एक फाइल में तब तक न मिलाएं जब तक कि लेख यह न बताए कि उन कार्रवाइयों को एक साथ क्यों भेजा जाना चाहिए।
- प्रति स्क्रिप्ट एक मुख्य उद्देश्य का उपयोग करें।
- फ़ाइल के शीर्ष पर स्पष्ट टिप्पणियाँ रखें।
- शीर्ष के निकट विन्यास योग्य मानों को समूहित करें।
- निजी पथों को तब तक हार्डकोड न करें जब तक कि लेख उन्हें स्पष्ट न कर दे।
- अनावश्यक डेटाबेस लेखन से बचें.
- हब इवेंट से नेटवर्क कॉल को ब्लॉक करने से बचें।
- लॉगिन, चैट या उपयोगकर्ता-सूची हुक के अंदर भारी लूप से बचें।
- स्टार्टअप और शटडाउन व्यवहार को स्पष्ट करें।
- दस्तावेज़ लोड, पुनः लोड और अनलोड आदेश।
उत्पादन केंद्रों के लिए, असंबद्ध हब व्यवहार को नियंत्रित करने वाली एक बड़ी फ़ाइल की तुलना में छोटी स्क्रिप्ट को डीबग करना, अक्षम करना और प्रतिस्थापित करना आमतौर पर आसान होता है।
सुझाया गया स्क्रिप्ट हेडर
प्रत्येक स्क्रिप्ट को एक संक्षिप्त टिप्पणी ब्लॉक के साथ प्रारंभ करें। स्क्रिप्ट के लाइव हब को छूने से पहले हेडर को अगले ऑपरेटर को बताना चाहिए कि फ़ाइल क्या है।
-- Script: time.lua
-- Purpose: Displays a clock-like bot entry in the Verlihub user list.
-- Scope: User-list display only.
-- Author: PWiAM
-- Notes: Test on a private hub before production use.सुझाए गए स्क्रिप्ट आलेख प्रारूप
इस अनुभाग में प्रत्येक बाल लेख को एक ही आकार का उपयोग करना चाहिए ताकि स्क्रिप्ट की तुलना और समीक्षा शीघ्रता से की जा सके।
- सिंहावलोकन.
- आवश्यकताएं।
- स्थापना.
- विन्यास।
- स्क्रिप्ट लोड हो रही है.
- परीक्षण.
- अनलोड करना या अक्षम करना.
- समस्या निवारण।
- पूरी स्क्रिप्ट.
- संबंधित पृष्ठ.
स्क्रिप्ट स्थापित करना
सटीक स्थान Verlihub इंस्टॉल पथ पर निर्भर करता है, लेकिन कस्टम Lua फ़ाइलें हब चलाने वाले सेवा उपयोगकर्ता के स्वामित्व वाली निर्देशिका में रहनी चाहिए।
sudo mkdir -p /usr/local/etc/verlihub/lua
sudo chown -R verlihub:verlihub /usr/local/etc/verlihub/lua
sudo chmod 750 /usr/local/etc/verlihub/luaफिर प्रत्येक स्क्रिप्ट को उस निर्देशिका में रखें:
/usr/local/etc/verlihub/lua/time.luaयदि आपकी सेवा किसी भिन्न उपयोगकर्ता के अंतर्गत चलती है, तो उस खाते का स्वामी बदल दें। उपयोग नहीं करो chmod 777 /usr/local/etc/verlihub/lua. Lua फ़ाइलें हब प्रक्रिया के अंदर चलती हैं, इसलिए लेखन पहुंच केवल विश्वसनीय प्रशासकों की होती है।
स्क्रिप्ट लोड करना और पुनः लोड करना
Lua स्क्रिप्ट के लिए Verlihub Lua प्लगइन को पहले इंस्टॉल और सक्षम करना आवश्यक है। यदि प्लगइन लोड नहीं हुआ है, तो स्क्रिप्ट फ़ाइलें लोड करने से पहले मूल Lua सेटअप आलेख की समीक्षा करें।
उपयोगी प्लगइन जाँच में शामिल हैं:
!pluglist!lstplug
लाइव स्क्रिप्ट को संपादित करते समय छोटे परिवर्तन वाले वर्कफ़्लो का उपयोग करें:
- वर्तमान कार्यशील फ़ाइल का बैकअप सहेजें।
- एक सेटिंग या एक फ़ंक्शन बदलें.
- केवल उस स्क्रिप्ट को पुनः लोड करें यदि आपका निर्माण इसका समर्थन करता है।
- हब आउटपुट और Verlihub लॉग की जाँच करें।
- यदि उपयोगकर्ताओं को त्रुटियां, डुप्लिकेट बॉट या बार-बार चैट आउटपुट दिखाई देता है तो तुरंत वापस लौटें।
यदि आपके Verlihub बिल्ड में स्क्रिप्ट रीलोड कमांड उपलब्ध नहीं हैं, तो अपने सर्वर के प्लगइन प्रबंधन कमांड के अनुसार Lua प्लगइन को पुनरारंभ या पुनः लोड करें।
स्क्रिप्ट का सुरक्षित रूप से परीक्षण करना
उत्पादन में उन पर भरोसा करने से पहले एक निजी हब या शांत रखरखाव विंडो पर Lua स्क्रिप्ट का परीक्षण करें।
- सिंटैक्स त्रुटियों के बिना स्क्रिप्ट लोड की पुष्टि करें।
- पुष्टि करें कि यह मुख्य चैट को बाढ़ नहीं करता है।
- पुष्टि करें कि यह डुप्लिकेट बॉट या बार-बार उपयोगकर्ता-सूची प्रविष्टियाँ नहीं बनाता है।
- पुष्टि करें कि पुनः लोड करने के बाद यह सही ढंग से व्यवहार करता है।
- पुष्टि करें कि हब पुनरारंभ होने के बाद यह सही ढंग से व्यवहार करता है।
- कन्फ़र्म ऑपरेटर इसे शीघ्रता से अक्षम कर सकते हैं.
- कमांड स्क्रिप्ट के लिए, सामान्य उपयोगकर्ताओं और ऑपरेटर खातों के साथ परीक्षण करें।
- समयबद्ध संदेशों या उपयोगकर्ता-सूची प्रविष्टियों के लिए, अंतराल का परीक्षण करें ताकि स्क्रिप्ट शोर या लोड पैदा न करे।
उत्पादन सुरक्षा नोट्स
Lua कोड हब प्रक्रिया के अंदर चलता है। एक ख़राब स्क्रिप्ट चैट, लॉगिन, उपयोगकर्ता-सूची अपडेट या प्लगइन शटडाउन को प्रभावित कर सकती है।
टालना:
- अनंत लूप.
- इवेंट हैंडलर्स के अंदर लंबी नींद।
- उपयोगकर्ता ईवेंट के दौरान बड़ी फ़ाइल पढ़ी जाती है।
- बाहरी HTTP अनुरोधों को अवरुद्ध करना।
- चैट या लॉगिन हुक से भारी डेटाबेस क्वेरीज़।
- संदेशों को बिना किसी सीमा के बार-बार प्रसारित करना।
- ऐसी स्क्रिप्ट जिन्हें साफ़-साफ़ अपलोड नहीं किया जा सकता.
पसंद करना:
- छोटे इवेंट संचालक.
- कॉन्फ़िगरेशन मान साफ़ करें.
- रूढ़िवादी टाइमर.
- सरल आदेश तर्क.
- लॉगिंग तभी करें जब यह ऑपरेटर को उपयोगी जानकारी दे।
- आसान रोलबैक.
यदि कोई कार्य लंबे समय से चल रहा है, तो उसे Verlihub से बाहर ले जाएं और Lua को ट्रिगर करने दें या परिणाम प्रदर्शित करने दें।
संस्करण नियंत्रण
जब संभव हो तो कस्टम स्क्रिप्ट को Git में रखें। स्क्रिप्ट निर्देशिका में एक छोटा भंडार कई हब के लिए पर्याप्त है।
cd /usr/local/etc/verlihub/lua
git init
git add .
git commit -m "Initial Verlihub Lua scripts"किसी प्रोडक्शन स्क्रिप्ट को संपादित करने से पहले, जाँच लें कि पहले से क्या बदला गया है:
git status
git diffपरिवर्तन का परीक्षण करने के बाद:
git add time.lua
git commit -m "Update time.lua clock display"यह अगले ऑपरेटर को परिवर्तन इतिहास और तेज़ रोलबैक पथ देता है।
उपलब्ध स्क्रिप्ट
time.lua Verlihub उपयोगकर्ता सूची घड़ी स्क्रिप्ट एक छोटी बॉट-जैसी उपयोगकर्ता-सूची प्रविष्टि बनाता है जो वर्तमान समय प्रदर्शित करती है।
इसका उपयोग तब करें जब कोई हब एक अलग बॉट प्रक्रिया या बाहरी सेवा चलाए बिना दृश्यमान घड़ी प्रविष्टि चाहता हो। यह इस लाइब्रेरी में पहला अनुरक्षित उदाहरण है और इसे अन्य डिस्प्ले-ओरिएंटेड स्क्रिप्ट के लिए एक पैटर्न के रूप में उपयोग किया जा सकता है।
अधिक स्क्रिप्ट जोड़ना
नई स्क्रिप्ट को इस अनुभाग के अंतर्गत बाल आलेख के रूप में जोड़ा जाना चाहिए, न कि इस अनुक्रमणिका पृष्ठ पर चिपकाया जाना चाहिए। अच्छे उम्मीदवारों में शामिल हैं:
- स्वागत संदेश स्क्रिप्ट.
- नियम अनुस्मारक स्क्रिप्ट.
- ऑपरेटर हेल्पर कमांड स्क्रिप्ट।
- अनुसूचित घोषणा स्क्रिप्ट.
- उपयोगकर्ता गणना प्रदर्शन स्क्रिप्ट.
- एंटी-स्पैम सहायक स्क्रिप्ट.
- हब सूचना कमांड स्क्रिप्ट।
- रखरखाव मोड नोटिस स्क्रिप्ट.
प्रत्येक नए आलेख में इंस्टॉलेशन नोट्स, कॉन्फ़िगरेशन मान, परीक्षण चरण, अनलोड चरण और पूर्ण स्क्रिप्ट सूची शामिल होनी चाहिए।