You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs-src/commands.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,19 +93,19 @@ namespace MyCommandPlugin
93
93
}
94
94
```
95
95
96
-
Download the InEngineCli tool that matches the version of the InEngine.Core package you included from the [GitHub Releases](https://github.com/InEngine-NET/InEngine.NET/releases) page.
96
+
Download the InEngine binary distribution, from the [GitHub Releases](https://github.com/InEngine-NET/InEngine.NET/releases) page, that matches the version of the InEngine.Core package you included.
97
97
98
-
Copy your project's DLLs into the same directory as InEngineCli.exe.
98
+
Copy your project's DLLs into the same directory as inengine.exe.
99
99
100
100
Run your command...
101
101
102
102
```bash
103
-
InEngineCli.exe -pMyCommandPlugin my-command
103
+
inengine.exe -pMyCommandPlugin my-command
104
104
```
105
105
106
106
## Discover Command Plugins
107
107
108
-
Run InEngineCli.exe without any arguments to see a list of arguments.
108
+
Run inengine.exe without any arguments to see a list of plugins.
109
109
110
110
```text
111
111
@@ -127,10 +127,10 @@ Plugins:
127
127
128
128
## Discover Commands in a Plugin
129
129
130
-
Run InEngineCli.exe with only the plugin specified.
130
+
Run inengine.exe with only the plugin specified.
131
131
132
132
```bash
133
-
InEngineCli.exe -pInEngine.Core
133
+
inengine.exe -pInEngine.Core
134
134
```
135
135
136
136
The **InEngine.Core** library is itself a plugin that contains queue related commands.
@@ -161,10 +161,10 @@ Commands:
161
161
Run the command with the -h or --help arguments.
162
162
163
163
```bash
164
-
InEngineCli.exe -pInEngine.Core queue:clear -h
164
+
inengine.exe -pInEngine.Core queue:clear -h
165
165
```
166
166
167
-
The **InEngine.Core** plugin's command to clear the InEngine.NET's queues produces this help message.
167
+
The **InEngine.Core** plugin's command to clear the InEngine.NET queues produces this help message.
Copy file name to clipboardExpand all lines: docs-src/scheduling.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Scheduling
2
2
3
-
[Commands](commands) can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent [release](https://github.com/InEngine-NET/InEngine.NET/releases).
3
+
[Commands](commands) can be scheduled to run by leveraging the inengine.exe program, available as a download from a recent [release](https://github.com/InEngine-NET/InEngine.NET/releases).
4
4
5
5
## Scheduling a Command
6
6
@@ -59,16 +59,16 @@ namespace MyCommandPlugin
59
59
60
60
### Manually from the CLI
61
61
62
-
Running the scheduler from the CommandLine is useful for debugging or local development. Simply run *InEngineScheduler.exe* from the command line.
62
+
Running the scheduler from the CommandLine is useful for debugging or local development. Simply run *inengine.exe* from the command line.
63
63
64
64
```bash
65
-
InEngineScheduler.exe
65
+
inengine.exe
66
66
```
67
67
68
68
It can also be run on Mac/Linux with Mono.
69
69
70
70
```bash
71
-
mono InEngineScheduler.exe
71
+
mono inengine.exe
72
72
```
73
73
74
74
### On Windows as a Service
@@ -109,7 +109,7 @@ Supervisor configuration files are stored in the **/etc/supervisor/conf.d** dire
Copy file name to clipboardExpand all lines: docs/mkdocs/search_index.json
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -67,12 +67,12 @@
67
67
},
68
68
{
69
69
"location": "/scheduling/",
70
-
"text": "Scheduling\n\n\nCommands\n can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent \nrelease\n.\n\n\nScheduling a Command\n\n\nA job schedule is created by adding a class to your plugin assembly that implements the \nInEngine.Core.Jobs\n interface.\n\n\n\nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n // Schedule some jobs\n }\n }\n}\n\n\n\n\nThis class is automatically discovered by the InEngine.NET scheduler.\nIt will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object.\n\n\nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n var myCommand = new MyCommand();\n\n // Generate a schedulable job with the command.\n var job = myCommand.MakeTriggerBuilder().Build();\n\n // Generate a trigger for the job, and set its schedule to every 10 seconds.\n var trigger = myCommand.MakeTriggerBuilder().Build()\n .StartNow()\n .WithSimpleSchedule(x =\n x.WithIntervalInSeconds(10).RepeatForever())\n .Build();\n\n // Register the job and trigger with the scheduler.\n scheduler.ScheduleJob(job, trigger);\n }\n }\n}\n\n\n\n\n\nRunning the Scheduler\n\n\nManually from the CLI\n\n\nRunning the scheduler from the CommandLine is useful for debugging or local development. Simply run \nInEngineScheduler.exe\n from the command line.\n\n\nInEngineScheduler.exe\n\n\n\n\nIt can also be run on Mac/Linux with Mono.\n\n\nmono InEngineScheduler.exe\n\n\n\n\nOn Windows as a Service\n\n\nInstalling\n\n\nRun the Install.ps1 PowerShell script in the scheduler directory to install the scheduler in place. The script needs to be run as an administrator. The script will register the service at the location where the script is run. \n\n\nps Install.ps1\n\n\n\n\nUninstalling\n\n\nSimply run the \nUninstall.ps1\n script with elevated permissions to unregister the service.\n\n\nps Uninstall.ps1\n\n\n\n\nOn Linux with Supervisor\n\n\nSupervisor is a process control system for Linux. It has extensive \ndocumentation\n, but the following should be enough to get started.\n\n\nInstalling Supervisor\n\n\nThis command installs Supervisor on Ubuntu:\n\n\nsudo apt-get install supervisor\n\n\n\n\nConfiguring Supervisor\n\n\nSupervisor configuration files are stored in the \n/etc/supervisor/conf.d\n directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called \n/etc/supervisor/conf.d/inengine-scheduler.conf\n. \n\n\n[program:inengine-scheudler]\nprocess_name=%(program_name)s_%(process_num)02d\ndirectory=/path/to/scheduler\ncommand=mono InEngineScheduler.exe\nautostart=true\nautorestart=true\nuser=InEngine\nnumprocs=1\nredirect_stderr=true\nstdout_logfile=./scheduler.log\n\n\n\n\nStarting Supervisor\n\n\nWhenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.\n\n\nsudo supervisorctl reread\nsudo supervisorctl update\n\n\n\n\nNow, simply start the InEngine Scheduler.\n\n\nsudo supervisorctl start inengine-scheduler:*",
70
+
"text": "Scheduling\n\n\nCommands\n can be scheduled to run by leveraging the inengine.exe program, available as a download from a recent \nrelease\n.\n\n\nScheduling a Command\n\n\nA job schedule is created by adding a class to your plugin assembly that implements the \nInEngine.Core.Jobs\n interface.\n\n\n\nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n // Schedule some jobs\n }\n }\n}\n\n\n\n\nThis class is automatically discovered by the InEngine.NET scheduler.\nIt will call the Jobs.Schedule method with an initialized Quartz.NET scheduler object.\n\n\nusing System;\nusing Quartz;\n\nnamespace MyCommandPlugin\n{\n public class Jobs : IJobs\n {\n public void Schedule(IScheduler scheduler)\n {\n var myCommand = new MyCommand();\n\n // Generate a schedulable job with the command.\n var job = myCommand.MakeTriggerBuilder().Build();\n\n // Generate a trigger for the job, and set its schedule to every 10 seconds.\n var trigger = myCommand.MakeTriggerBuilder().Build()\n .StartNow()\n .WithSimpleSchedule(x =\n x.WithIntervalInSeconds(10).RepeatForever())\n .Build();\n\n // Register the job and trigger with the scheduler.\n scheduler.ScheduleJob(job, trigger);\n }\n }\n}\n\n\n\n\n\nRunning the Scheduler\n\n\nManually from the CLI\n\n\nRunning the scheduler from the CommandLine is useful for debugging or local development. Simply run \ninengine.exe\n from the command line.\n\n\ninengine.exe\n\n\n\n\nIt can also be run on Mac/Linux with Mono.\n\n\nmono inengine.exe\n\n\n\n\nOn Windows as a Service\n\n\nInstalling\n\n\nRun the Install.ps1 PowerShell script in the scheduler directory to install the scheduler in place. The script needs to be run as an administrator. The script will register the service at the location where the script is run. \n\n\nps Install.ps1\n\n\n\n\nUninstalling\n\n\nSimply run the \nUninstall.ps1\n script with elevated permissions to unregister the service.\n\n\nps Uninstall.ps1\n\n\n\n\nOn Linux with Supervisor\n\n\nSupervisor is a process control system for Linux. It has extensive \ndocumentation\n, but the following should be enough to get started.\n\n\nInstalling Supervisor\n\n\nThis command installs Supervisor on Ubuntu:\n\n\nsudo apt-get install supervisor\n\n\n\n\nConfiguring Supervisor\n\n\nSupervisor configuration files are stored in the \n/etc/supervisor/conf.d\n directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called \n/etc/supervisor/conf.d/inengine-scheduler.conf\n. \n\n\n[program:inengine-scheudler]\nprocess_name=%(program_name)s_%(process_num)02d\ndirectory=/path/to/scheduler\ncommand=mono inengine.exe\nautostart=true\nautorestart=true\nuser=InEngine\nnumprocs=1\nredirect_stderr=true\nstdout_logfile=./scheduler.log\n\n\n\n\nStarting Supervisor\n\n\nWhenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.\n\n\nsudo supervisorctl reread\nsudo supervisorctl update\n\n\n\n\nNow, simply start the InEngine Scheduler.\n\n\nsudo supervisorctl start inengine-scheduler:*",
71
71
"title": "Scheduling"
72
72
},
73
73
{
74
74
"location": "/scheduling/#scheduling",
75
-
"text": "Commands can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent release .",
75
+
"text": "Commands can be scheduled to run by leveraging the inengine.exe program, available as a download from a recent release .",
76
76
"title": "Scheduling"
77
77
},
78
78
{
@@ -87,7 +87,7 @@
87
87
},
88
88
{
89
89
"location": "/scheduling/#manually-from-the-cli",
90
-
"text": "Running the scheduler from the CommandLine is useful for debugging or local development. Simply run InEngineScheduler.exe from the command line. InEngineScheduler.exe It can also be run on Mac/Linux with Mono. mono InEngineScheduler.exe",
90
+
"text": "Running the scheduler from the CommandLine is useful for debugging or local development. Simply run inengine.exe from the command line. inengine.exe It can also be run on Mac/Linux with Mono. mono inengine.exe",
"text": "Supervisor configuration files are stored in the /etc/supervisor/conf.d directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called /etc/supervisor/conf.d/inengine-scheduler.conf . [program:inengine-scheudler]\nprocess_name=%(program_name)s_%(process_num)02d\ndirectory=/path/to/scheduler\ncommand=mono InEngineScheduler.exe\nautostart=true\nautorestart=true\nuser=InEngine\nnumprocs=1\nredirect_stderr=true\nstdout_logfile=./scheduler.log",
120
+
"text": "Supervisor configuration files are stored in the /etc/supervisor/conf.d directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called /etc/supervisor/conf.d/inengine-scheduler.conf . [program:inengine-scheudler]\nprocess_name=%(program_name)s_%(process_num)02d\ndirectory=/path/to/scheduler\ncommand=mono inengine.exe\nautostart=true\nautorestart=true\nuser=InEngine\nnumprocs=1\nredirect_stderr=true\nstdout_logfile=./scheduler.log",
Copy file name to clipboardExpand all lines: docs/scheduling/index.html
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -105,7 +105,7 @@
105
105
<divclass="col-md-9" role="main">
106
106
107
107
<h1id="scheduling">Scheduling</h1>
108
-
<p><ahref="../commands">Commands</a> can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent <ahref="https://github.com/InEngine-NET/InEngine.NET/releases">release</a>.</p>
108
+
<p><ahref="../commands">Commands</a> can be scheduled to run by leveraging the inengine.exe program, available as a download from a recent <ahref="https://github.com/InEngine-NET/InEngine.NET/releases">release</a>.</p>
109
109
<h2id="scheduling-a-command">Scheduling a Command</h2>
110
110
<p>A job schedule is created by adding a class to your plugin assembly that implements the <strong>InEngine.Core.Jobs</strong> interface.</p>
111
111
<pre><codeclass="csharp">
@@ -156,12 +156,12 @@ <h2 id="scheduling-a-command">Scheduling a Command</h2>
156
156
157
157
<h2id="running-the-scheduler">Running the Scheduler</h2>
158
158
<h3id="manually-from-the-cli">Manually from the CLI</h3>
159
-
<p>Running the scheduler from the CommandLine is useful for debugging or local development. Simply run <em>InEngineScheduler.exe</em> from the command line.</p>
160
-
<pre><codeclass="bash">InEngineScheduler.exe
159
+
<p>Running the scheduler from the CommandLine is useful for debugging or local development. Simply run <em>inengine.exe</em> from the command line.</p>
160
+
<pre><codeclass="bash">inengine.exe
161
161
</code></pre>
162
162
163
163
<p>It can also be run on Mac/Linux with Mono.</p>
164
-
<pre><codeclass="bash">mono InEngineScheduler.exe
164
+
<pre><codeclass="bash">mono inengine.exe
165
165
</code></pre>
166
166
167
167
<h3id="on-windows-as-a-service">On Windows as a Service</h3>
0 commit comments