This guide helps you install and configure Meeseeks as quickly as possible.

1

Add the dependency

To integrate Meeseeks into your project, add the dependency.

  [versions]
  meeseeks = "1.0.0"

  [libraries]
  meeseeks-runtime = { group = "dev.mattramotar.meeseeks", name = "runtime", version.ref = "meeseeks" }
2

(iOS Only) Register BGTaskScheduler Identifiers

In your Info.plist file, add the following:

<key>BGTaskSchedulerPermittedIdentifiers</key>
<array>
  <string>dev.mattramotar.meeseeks.periodic.task</string>
  <string>dev.mattramotar.meeseeks.onetime.task</string>
</array>
3

Initialize Meeseeks

class MyApp : Application(), MeeseeksContext {
   override fun onCreate() {
    initializeMeeseeks()
  }

  private fun initializeMeeseeks() {
    val config = MeeseeksBoxConfig(
      maxParallelTasks = 2,
      backoffMinimumMillis = 10000
    )

    return Meeseeks.initialize(
        context = this,
        config = config
    ) {
      register(MeeseeksType.SYNC) { task -> SyncingMeeseeks(task) }
      register(MeeseeksType.POLL) { task -> PollingMeeseeks(task) }
    }
  }
}
4

(JS Only) Service Worker Setup

If your browser supports Background Sync or Periodic Background Sync, you can handle tasks even when the tab isn’t active.

Example service-worker.js:

self.addEventListener('sync', event => {
  if (event.tag && event.tag.startsWith("meeseeks-")) {
    event.waitUntil(handleSync(event.tag));
  }
});

self.addEventListener('periodicsync', event => {
  if (event.tag && event.tag.startsWith("meeseeks-")) {
    event.waitUntil(handleSync(event.tag));
  }
});

async function handleSync(tag) {
  if (self.MeeseeksBGTaskRunner && self.MeeseeksBGTaskRunner.run) {
    await self.MeeseeksBGTaskRunner.run(tag);
  }
};
5

Get the Meeseeks box

The MeeseeksBox is the global manager of all scheduled tasks. It is what you need to summon a MrMeeseeks.

val meeseeksBox = MeeseeksBox.value
6

Define a task

val task = Task(
  MeeseeksType.SYNC,
  parameters = taskParametersOf {
    KEY_USER_ID to "RICKC137"
    KEY_DIMENSION_ID to 137
    KEY_SYNC_PROTOCOL to SyncProtocol.INTERDIMENSIONAL
    KEY_COUNCIL_OVERRIDE to true
    KEY_USER_TAGS toList {"portal-gun-user"}
  },
  preconditions = TaskPreconditions(
    requiresNetwork = true,
    requiresCharging = false,
    requiresBatteryNotLow = false
  ),
  priority = TaskPriority.HIGH,
  schedule = TaskSchedule.Periodic(interval = 60.seconds),
  retryPolicy = TaskRetryPolicy.ExponentialBackoff(initialDelay = 1.seconds, maxRetries = 3)
)
7

Summon a Meeseeks

Meeseeks will execute the task in the background.

val meeseeksId = meeseeksBox.summon(task)

Explore advanced usage like custom preconditions, advanced concurrency, or building your own MrMeeseeks in the Advanced Docs.

​
Frequently asked questions

​
Next steps

Yes siree! You’ve successfully initialized Meeseeks, configured your first tasks, and seen how to track results. Use the resources below to keep learning.

Concepts

Learn how tasks, scheduling, concurrency, and logging really work under the hood.

Advanced usage

Build custom Meeseeks, handle special concurrency cases, or dive into debugging tasks.

Community

Contribute, ask questions, or file issues on our GitHub repo.

Was this page helpful?

Suggest editsRaise issue